@sisense/sdk-ui-vue 1.4.1 → 1.6.0

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

@@ -38,5 +38,7 @@ import type { MaybeWithRefs } from '../types';
  *
  * Utilizing this composable allows for declarative and reactive handling of widget-specific queries within Vue applications,
  * facilitating easier data fetching and state management with the Sisense SDK.
+ *
+ * @group Fusion Assets
  */
 export declare const useExecuteQueryByWidgetId: (params: MaybeWithRefs<ExecuteQueryByWidgetIdParams>) => ToRefs<QueryByWidgetIdState>;

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

@@ -40,5 +40,6 @@ import type { MaybeWithRefs } from '../types';
  *
  * 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 useExecuteQuery: (params: MaybeWithRefs<ExecuteQueryParams>) => import("vue").ToRefs<import("@sisense/sdk-ui-preact").QueryState>;

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

@@ -37,5 +37,6 @@ import type { GetDashboardModelParams } from '@sisense/sdk-ui-preact';
  *
  * Utilizing this composable enables developers to declaratively integrate Sisense dashboard analytics into their Vue applications,
  * managing data fetching and state with minimal boilerplate code.
+ * @group Fusion Assets
  */
 export declare const useGetDashboardModel: (params: MaybeWithRefs<GetDashboardModelParams>) => import("vue").ToRefs<import("@sisense/sdk-ui-preact").DashboardModelState>;

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

@@ -34,5 +34,6 @@ import type { MaybeWithRefs } from '../types';
  *
  * This composable is ideal for Vue applications requiring a list of Sisense dashboards, providing a streamlined, reactive
  * way to fetch and manage the state of multiple dashboard models.
+ * @group Fusion Assets
  */
 export declare const useGetDashboardModels: (params: MaybeWithRefs<GetDashboardModelsParams>) => import("vue").ToRefs<import("@sisense/sdk-ui-preact").DashboardModelsState>;

package/dist/src/composables/use-get-shared-formula.d.ts

@@ -41,5 +41,6 @@ import type { MaybeWithRefs } from '../types';
  * - `error`: Contains the error object if an error occurred during the fetch.
  *
  * This composable provides a streamlined, reactive approach to fetching shared formulas from Sisense, facilitating their integration into Vue applications for enhanced data analytics capabilities.
+ * @group Fusion Assets
  */
 export declare const useGetSharedFormula: (params: MaybeWithRefs<UseGetSharedFormulaParams>) => import("vue").ToRefs<import("@sisense/sdk-ui-preact").SharedFormulaState>;

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

@@ -37,5 +37,6 @@ import type { MaybeWithRefs } from '../types';
  *
  * This composable streamlines the process of fetching and managing Sisense widget models within Vue applications, providing
  * developers with a reactive and efficient way to integrate Sisense data visualizations and analytics.
+ * @group Fusion Assets
  */
 export declare const useGetWidgetModel: (params: MaybeWithRefs<GetWidgetModelParams>) => import("vue").ToRefs<import("@sisense/sdk-ui-preact").DataState<WidgetModel>>;

package/dist/src/lib.d.ts

@@ -4,5 +4,7 @@ export * from './components/filters';
 export * from './providers';
 export * from './composables';
 export * from './components/context-menu';
+export * from './types';
 export { default as DrilldownWidget } from './components/drilldown-widget.vue';
 export * from './sdk-ui-core-exports';
+export * from './components/widgets';

package/dist/src/providers/index.d.ts

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

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

@@ -1,20 +1,17 @@
 import type { PropType, Ref } from 'vue';
-import { ClientApplication } from '@sisense/sdk-ui-preact';
+import { type CustomSisenseContext } from '@sisense/sdk-ui-preact';
 /**
  * Gets Sisense application
  * @internal
  */
-export declare const getApp: () => Ref<ClientApplication | undefined>;
+export declare const getSisenseContext: () => Ref<CustomSisenseContext>;
 /**
  * Creates Sisense context connector
  * @internal
  */
-export declare const createSisenseContextConnector: (app: ClientApplication) => {
-    prepareContext(): Promise<{
-        app: ClientApplication;
-        isInitialized: boolean;
-    }>;
-    renderContextProvider: (contextData: import("@sisense/sdk-ui-preact").CustomSisenseContext | undefined, children: import("preact").VNode<{}>, error?: Error | undefined) => import("preact").VNode<{}>;
+export declare const createSisenseContextConnector: (context: CustomSisenseContext) => {
+    prepareContext(): Promise<CustomSisenseContext>;
+    renderContextProvider: (contextData: CustomSisenseContext | undefined, children: import("preact").VNode<{}>, error?: Error | undefined) => import("preact").VNode<{}>;
 };
 /**
  * Sisense Context Provider Component allowing you to connect to
@@ -62,9 +59,10 @@ export declare const createSisenseContextConnector: (app: ClientApplication) =>
  *
  * @param props - Sisense context provider props
  * @returns A Sisense Context Provider Component
+ * @group Contexts
  */
 export declare const SisenseContextProvider: import("vue").DefineComponent<{
-    defaultDataSource: PropType<string | undefined>;
+    defaultDataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
     url: PropType<string>;
     ssoEnabled: PropType<boolean | undefined>;
     token: PropType<string | undefined>;
@@ -73,15 +71,21 @@ export declare const SisenseContextProvider: import("vue").DefineComponent<{
     /**
      * @internal
      */
-    showRuntimeErrors: PropType<boolean | undefined>;
+    showRuntimeErrors: {
+        type: PropType<boolean | undefined>;
+        default: boolean;
+    };
     /**
      * @internal
      */
-    enableTracking: PropType<boolean | undefined>;
+    enableTracking: {
+        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").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    defaultDataSource: PropType<string | undefined>;
+    defaultDataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
     url: PropType<string>;
     ssoEnabled: PropType<boolean | undefined>;
     token: PropType<string | undefined>;
@@ -90,9 +94,18 @@ export declare const SisenseContextProvider: import("vue").DefineComponent<{
     /**
      * @internal
      */
-    showRuntimeErrors: PropType<boolean | undefined>;
+    showRuntimeErrors: {
+        type: PropType<boolean | undefined>;
+        default: boolean;
+    };
     /**
      * @internal
      */
-    enableTracking: PropType<boolean | undefined>;
-}>>, {}, {}>;
+    enableTracking: {
+        type: PropType<boolean | undefined>;
+        default: boolean;
+    };
+}>>, {
+    showRuntimeErrors: boolean | undefined;
+    enableTracking: boolean | undefined;
+}, {}>;

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

@@ -27,6 +27,7 @@ export declare const getThemeContext: () => Ref<{
 }> | undefined;
 /**
  * Creates theme context connector
+ * @internal
  */
 export declare const createThemeContextConnector: (themeSettings?: CompleteThemeSettings) => {
     prepareContext(): Promise<{
@@ -136,6 +137,7 @@ export declare const createThemeContextConnector: (themeSettings?: CompleteTheme
  * @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>;

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

@@ -1,5 +1,5 @@
 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, MemberFilterTileProps, CriteriaFilterTileProps, DateRangeFilterTileProps, ChartWidgetProps, TableWidgetProps, TableProps, PivotTableProps, DrilldownBreadcrumbsProps, BoxplotChartProps, AreamapChartProps, ScattermapChartProps, SisenseContextProviderProps, ExecuteQueryByWidgetIdParams, ExecuteQueryParams, GetWidgetModelParams, ExecuteCsvQueryParams, 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, ChartStyleOptions, LineStyleOptions, AreaStyleOptions, StackableStyleOptions, PieStyleOptions, FunnelStyleOptions, PolarStyleOptions, IndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, NumericBarIndicatorStyleOptions, GaugeIndicatorStyleOptions, ScatterStyleOptions, TreemapStyleOptions, SunburstStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, ChartWidgetStyleOptions, WidgetStyleOptions, DashboardWidgetStyleOptions, TableStyleOptions, PivotTableStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, WidgetModel, DashboardModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, 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';
+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, MemberFilterTileProps, CriteriaFilterTileProps, DateRangeFilterTileProps, ChartWidgetProps, TableWidgetProps, TableProps, PivotTableProps, DrilldownBreadcrumbsProps, BoxplotChartProps, AreamapChartProps, ScattermapChartProps, SisenseContextProviderProps, DashboardWidgetProps, 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, ChartStyleOptions, LineStyleOptions, AreaStyleOptions, StackableStyleOptions, PieStyleOptions, FunnelStyleOptions, PolarStyleOptions, IndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, NumericBarIndicatorStyleOptions, GaugeIndicatorStyleOptions, ScatterStyleOptions, TreemapStyleOptions, SunburstStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, ChartWidgetStyleOptions, WidgetStyleOptions, DashboardWidgetStyleOptions, TableStyleOptions, PivotTableStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, WidgetModel, DashboardModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, 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.4.1",
+  "version": "1.6.0",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -34,6 +34,7 @@
     "format:check": "prettier --check ."
   },
   "dependencies": {
+    "@sisense/sdk-ui-preact": "^1.6.0",
     "deepmerge": "^4.3.1",
     "lodash": "^4.17.21",
     "vue": "^3.3.2"