@sisense/sdk-ui-vue 2.29.0 → 2.31.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/dist/ai.cjs +1 -1
  2. package/dist/ai.d.ts +1 -1
  3. package/dist/ai.js +1 -1
  4. package/dist/index.cjs +1 -1
  5. package/dist/index.d.ts +1 -1
  6. package/dist/index.js +441 -403
  7. package/dist/{packages/sdk-ui-vue/src → src}/components/dashboard/dashboard-by-id.d.ts +16 -3
  8. package/dist/{packages/sdk-ui-vue/src → src}/components/dashboard/dashboard.d.ts +21 -3
  9. package/dist/{packages/sdk-ui-vue/src → src}/components/widgets/chart-widget.d.ts +12 -0
  10. package/dist/{packages/sdk-ui-vue/src → src}/components/widgets/widget.d.ts +26 -0
  11. package/dist/{packages/sdk-ui-vue/src → src}/composables/index.d.ts +1 -1
  12. package/dist/{packages/sdk-ui-vue/src → src}/composables/use-composed-dashboard.d.ts +6 -2
  13. package/dist/{packages/sdk-ui-vue/src → src}/composables/use-execute-query.d.ts +28 -1
  14. package/dist/{packages/sdk-ui-vue/src → src}/composables/use-jtd-widget.d.ts +28 -1
  15. package/dist/src/providers/sisense-context-provider/sisense-context-provider.d.ts +224 -0
  16. package/dist/{packages/sdk-ui-vue/src → src}/sdk-ui-core-exports.d.ts +1 -1
  17. package/dist/translations/de-de.d.ts +1 -1
  18. package/dist/translations/en-us.d.ts +1 -1
  19. package/dist/translations/es-ar.d.ts +1 -1
  20. package/dist/translations/es-es.d.ts +1 -1
  21. package/dist/translations/fr-fr.d.ts +1 -1
  22. package/dist/translations/it-it.d.ts +1 -1
  23. package/dist/translations/ja-jp.d.ts +1 -1
  24. package/dist/translations/ko-kr.d.ts +1 -1
  25. package/dist/translations/nl-nl.d.ts +1 -1
  26. package/dist/translations/pt-br.d.ts +1 -1
  27. package/dist/translations/ru-ru.d.ts +1 -1
  28. package/dist/translations/tr-tr.d.ts +1 -1
  29. package/dist/translations/zh-cn.d.ts +1 -1
  30. package/dist/{use-tracking-b2365036.js → use-tracking-1cbd274b.js} +171 -156
  31. package/dist/use-tracking-94bc9fc5.cjs +1 -0
  32. package/package.json +12 -13
  33. package/dist/use-tracking-a5140061.cjs +0 -1
  34. /package/dist/{packages/sdk-ui-vue/src → src}/ai/components/chatbot.d.ts +0 -0
  35. /package/dist/{packages/sdk-ui-vue/src → src}/ai/components/get-nlg-insights.d.ts +0 -0
  36. /package/dist/{packages/sdk-ui-vue/src → src}/ai/components/index.d.ts +0 -0
  37. /package/dist/{packages/sdk-ui-vue/src → src}/ai/composables/index.d.ts +0 -0
  38. /package/dist/{packages/sdk-ui-vue/src → src}/ai/composables/use-get-nlg-insights.d.ts +0 -0
  39. /package/dist/{packages/sdk-ui-vue/src → src}/ai/composables/use-get-nlq-result.d.ts +0 -0
  40. /package/dist/{packages/sdk-ui-vue/src → src}/ai/composables/use-get-query-recommendations.d.ts +0 -0
  41. /package/dist/{packages/sdk-ui-vue/src → src}/ai/helpers/context-connectors/ai-context-connector.d.ts +0 -0
  42. /package/dist/{packages/sdk-ui-vue/src → src}/ai/helpers/context-connectors/index.d.ts +0 -0
  43. /package/dist/{packages/sdk-ui-vue/src → src}/ai/index.d.ts +0 -0
  44. /package/dist/{packages/sdk-ui-vue/src → src}/ai/providers/ai-context-provider/ai-context-provider.d.ts +0 -0
  45. /package/dist/{packages/sdk-ui-vue/src → src}/ai/providers/ai-context-provider/ai-context.d.ts +0 -0
  46. /package/dist/{packages/sdk-ui-vue/src → src}/ai/providers/ai-context-provider/index.d.ts +0 -0
  47. /package/dist/{packages/sdk-ui-vue/src → src}/ai/providers/index.d.ts +0 -0
  48. /package/dist/{packages/sdk-ui-vue/src → src}/ai/sdk-ui-core-exports.d.ts +0 -0
  49. /package/dist/{packages/sdk-ui-vue/src → src}/components/charts/area-chart.d.ts +0 -0
  50. /package/dist/{packages/sdk-ui-vue/src → src}/components/charts/area-range-chart.d.ts +0 -0
  51. /package/dist/{packages/sdk-ui-vue/src → src}/components/charts/areamap-chart.d.ts +0 -0
  52. /package/dist/{packages/sdk-ui-vue/src → src}/components/charts/bar-chart.d.ts +0 -0
  53. /package/dist/{packages/sdk-ui-vue/src → src}/components/charts/boxplot-chart.d.ts +0 -0
  54. /package/dist/{packages/sdk-ui-vue/src → src}/components/charts/calendar-heatmap-chart.d.ts +0 -0
  55. /package/dist/{packages/sdk-ui-vue/src → src}/components/charts/chart.d.ts +0 -0
  56. /package/dist/{packages/sdk-ui-vue/src → src}/components/charts/column-chart.d.ts +0 -0
  57. /package/dist/{packages/sdk-ui-vue/src → src}/components/charts/funnel-chart.d.ts +0 -0
  58. /package/dist/{packages/sdk-ui-vue/src → src}/components/charts/index.d.ts +0 -0
  59. /package/dist/{packages/sdk-ui-vue/src → src}/components/charts/indicator-chart.d.ts +0 -0
  60. /package/dist/{packages/sdk-ui-vue/src → src}/components/charts/line-chart.d.ts +0 -0
  61. /package/dist/{packages/sdk-ui-vue/src → src}/components/charts/pie-chart.d.ts +0 -0
  62. /package/dist/{packages/sdk-ui-vue/src → src}/components/charts/pivot-table.d.ts +0 -0
  63. /package/dist/{packages/sdk-ui-vue/src → src}/components/charts/polar-chart.d.ts +0 -0
  64. /package/dist/{packages/sdk-ui-vue/src → src}/components/charts/scatter-chart.d.ts +0 -0
  65. /package/dist/{packages/sdk-ui-vue/src → src}/components/charts/scattermap-chart.d.ts +0 -0
  66. /package/dist/{packages/sdk-ui-vue/src → src}/components/charts/streamgraph-chart.d.ts +0 -0
  67. /package/dist/{packages/sdk-ui-vue/src → src}/components/charts/sunburst-chart.d.ts +0 -0
  68. /package/dist/{packages/sdk-ui-vue/src → src}/components/charts/table.d.ts +0 -0
  69. /package/dist/{packages/sdk-ui-vue/src → src}/components/charts/treemap-chart.d.ts +0 -0
  70. /package/dist/{packages/sdk-ui-vue/src → src}/components/context-menu.d.ts +0 -0
  71. /package/dist/{packages/sdk-ui-vue/src → src}/components/dashboard/index.d.ts +0 -0
  72. /package/dist/{packages/sdk-ui-vue/src → src}/components/drilldown-breadcrumbs.d.ts +0 -0
  73. /package/dist/{packages/sdk-ui-vue/src → src}/components/drilldown-widget.d.ts +0 -0
  74. /package/dist/{packages/sdk-ui-vue/src → src}/components/drilldown-widget.vue.d.ts +0 -0
  75. /package/dist/{packages/sdk-ui-vue/src → src}/components/filters/criteria-filter-tile.d.ts +0 -0
  76. /package/dist/{packages/sdk-ui-vue/src → src}/components/filters/date-range-filter-tile.d.ts +0 -0
  77. /package/dist/{packages/sdk-ui-vue/src → src}/components/filters/filter-tile.d.ts +0 -0
  78. /package/dist/{packages/sdk-ui-vue/src → src}/components/filters/filters-panel.d.ts +0 -0
  79. /package/dist/{packages/sdk-ui-vue/src → src}/components/filters/index.d.ts +0 -0
  80. /package/dist/{packages/sdk-ui-vue/src → src}/components/filters/member-filter-tile.d.ts +0 -0
  81. /package/dist/{packages/sdk-ui-vue/src → src}/components/widgets/index.d.ts +0 -0
  82. /package/dist/{packages/sdk-ui-vue/src → src}/components/widgets/widget-by-id.d.ts +0 -0
  83. /package/dist/{packages/sdk-ui-vue/src → src}/composables/use-custom-widgets.d.ts +0 -0
  84. /package/dist/{packages/sdk-ui-vue/src → src}/composables/use-execute-csv-query.d.ts +0 -0
  85. /package/dist/{packages/sdk-ui-vue/src → src}/composables/use-execute-custom-widget-query.d.ts +0 -0
  86. /package/dist/{packages/sdk-ui-vue/src → src}/composables/use-execute-pivot-query.d.ts +0 -0
  87. /package/dist/{packages/sdk-ui-vue/src → src}/composables/use-execute-query-by-widget-id.d.ts +0 -0
  88. /package/dist/{packages/sdk-ui-vue/src → src}/composables/use-fetch.d.ts +0 -0
  89. /package/dist/{packages/sdk-ui-vue/src → src}/composables/use-get-dashboard-model.d.ts +0 -0
  90. /package/dist/{packages/sdk-ui-vue/src → src}/composables/use-get-dashboard-models.d.ts +0 -0
  91. /package/dist/{packages/sdk-ui-vue/src → src}/composables/use-get-data-source-dimensions.d.ts +0 -0
  92. /package/dist/{packages/sdk-ui-vue/src → src}/composables/use-get-filter-members.d.ts +0 -0
  93. /package/dist/{packages/sdk-ui-vue/src → src}/composables/use-get-hierarchy-models.d.ts +0 -0
  94. /package/dist/{packages/sdk-ui-vue/src → src}/composables/use-get-shared-formula.d.ts +0 -0
  95. /package/dist/{packages/sdk-ui-vue/src → src}/composables/use-get-widget-model.d.ts +0 -0
  96. /package/dist/{packages/sdk-ui-vue/src → src}/composables/use-tracking.d.ts +0 -0
  97. /package/dist/{packages/sdk-ui-vue/src → src}/helpers/context-connectors/custom-widgets-context-connector.d.ts +0 -0
  98. /package/dist/{packages/sdk-ui-vue/src → src}/helpers/context-connectors/index.d.ts +0 -0
  99. /package/dist/{packages/sdk-ui-vue/src → src}/helpers/context-connectors/plugin-context-connector.d.ts +0 -0
  100. /package/dist/{packages/sdk-ui-vue/src → src}/helpers/context-connectors/sisense-context-connector.d.ts +0 -0
  101. /package/dist/{packages/sdk-ui-vue/src → src}/helpers/context-connectors/theme-context-connector.d.ts +0 -0
  102. /package/dist/{packages/sdk-ui-vue/src → src}/helpers/setup-helper.d.ts +0 -0
  103. /package/dist/{packages/sdk-ui-vue/src → src}/helpers/use-reducer.d.ts +0 -0
  104. /package/dist/{packages/sdk-ui-vue/src → src}/helpers/use-ref-state.d.ts +0 -0
  105. /package/dist/{packages/sdk-ui-vue/src → src}/helpers/vue-component-adapter.d.ts +0 -0
  106. /package/dist/{packages/sdk-ui-vue/src → src}/lib.d.ts +0 -0
  107. /package/dist/{packages/sdk-ui-vue/src → src}/providers/custom-widgets-provider/custom-widgets-context.d.ts +0 -0
  108. /package/dist/{packages/sdk-ui-vue/src → src}/providers/custom-widgets-provider/custom-widgets-provider.d.ts +0 -0
  109. /package/dist/{packages/sdk-ui-vue/src → src}/providers/custom-widgets-provider/index.d.ts +0 -0
  110. /package/dist/{packages/sdk-ui-vue/src → src}/providers/index.d.ts +0 -0
  111. /package/dist/{packages/sdk-ui-vue/src → src}/providers/sisense-context-provider/index.d.ts +0 -0
  112. /package/dist/{packages/sdk-ui-vue/src → src}/providers/theme-provider/index.d.ts +0 -0
  113. /package/dist/{packages/sdk-ui-vue/src → src}/providers/theme-provider/theme-context.d.ts +0 -0
  114. /package/dist/{packages/sdk-ui-vue/src → src}/providers/theme-provider/theme-provider.d.ts +0 -0
  115. /package/dist/{packages/sdk-ui-vue/src → src}/translation/__external__/de-de.d.ts +0 -0
  116. /package/dist/{packages/sdk-ui-vue/src → src}/translation/__external__/en-us.d.ts +0 -0
  117. /package/dist/{packages/sdk-ui-vue/src → src}/translation/__external__/es-ar.d.ts +0 -0
  118. /package/dist/{packages/sdk-ui-vue/src → src}/translation/__external__/es-es.d.ts +0 -0
  119. /package/dist/{packages/sdk-ui-vue/src → src}/translation/__external__/fr-fr.d.ts +0 -0
  120. /package/dist/{packages/sdk-ui-vue/src → src}/translation/__external__/it-it.d.ts +0 -0
  121. /package/dist/{packages/sdk-ui-vue/src → src}/translation/__external__/ja-jp.d.ts +0 -0
  122. /package/dist/{packages/sdk-ui-vue/src → src}/translation/__external__/ko-kr.d.ts +0 -0
  123. /package/dist/{packages/sdk-ui-vue/src → src}/translation/__external__/nl-nl.d.ts +0 -0
  124. /package/dist/{packages/sdk-ui-vue/src → src}/translation/__external__/pt-br.d.ts +0 -0
  125. /package/dist/{packages/sdk-ui-vue/src → src}/translation/__external__/ru-ru.d.ts +0 -0
  126. /package/dist/{packages/sdk-ui-vue/src → src}/translation/__external__/tr-tr.d.ts +0 -0
  127. /package/dist/{packages/sdk-ui-vue/src → src}/translation/__external__/zh-cn.d.ts +0 -0
  128. /package/dist/{packages/sdk-ui-vue/src → src}/types/index.d.ts +0 -0
  129. /package/dist/{packages/sdk-ui-vue/src → src}/types/maybe-ref.d.ts +0 -0
  130. /package/dist/{packages/sdk-ui-vue/src → src}/utilities/dashboard-helpers.d.ts +0 -0
  131. /package/dist/{packages/sdk-ui-vue/src → src}/utilities/dashboard-model-translator.d.ts +0 -0
  132. /package/dist/{packages/sdk-ui-vue/src → src}/utilities/index.d.ts +0 -0
  133. /package/dist/{packages/sdk-ui-vue/src → src}/utilities/widget-model-translator.d.ts +0 -0
  134. /package/dist/{packages/sdk-ui-vue/src → src}/utils.d.ts +0 -0
@@ -1,10 +1,23 @@
1
- import type { DashboardByIdConfig, DashboardByIdProps as DashboardByIdPropsPreact } from '@sisense/sdk-ui-preact';
1
+ import type { DashboardByIdConfig as DashboardByIdConfigPreact, DashboardByIdProps as DashboardByIdPropsPreact } from '@sisense/sdk-ui-preact';
2
2
  import type { PropType } from 'vue';
3
- export { DashboardByIdConfig };
3
+ import type { DashboardHeaderConfig } from './dashboard';
4
+ /**
5
+ * Configuration for the {@link @sisense/sdk-ui-vue!DashboardById | `DashboardById`} component.
6
+ */
7
+ export interface DashboardByIdConfig extends Omit<DashboardByIdConfigPreact, 'header'> {
8
+ /**
9
+ * {@inheritDoc @sisense/sdk-ui!DashboardConfig.header}
10
+ */
11
+ header?: DashboardHeaderConfig;
12
+ }
4
13
  /**
5
14
  * Props of the {@link @sisense/sdk-ui-vue!DashboardById | `DashboardById`} component.
6
15
  */
7
- export interface DashboardByIdProps extends DashboardByIdPropsPreact {
16
+ export interface DashboardByIdProps extends Omit<DashboardByIdPropsPreact, 'config'> {
17
+ /**
18
+ * {@inheritDoc @sisense/sdk-ui!DashboardByIdProps.config}
19
+ */
20
+ config?: DashboardByIdConfig;
8
21
  }
9
22
  /**
10
23
  * A component used for easily rendering a dashboard by its ID in a Sisense Fusion instance.
@@ -1,15 +1,33 @@
1
- import type { DashboardConfig, DashboardFiltersPanelConfig, DashboardProps as DashboardPropsPreact } from '@sisense/sdk-ui-preact';
1
+ import type { DashboardConfig as DashboardConfigPreact, DashboardFiltersPanelConfig, DashboardHeaderConfig as DashboardHeaderConfigPreact, DashboardProps as DashboardPropsPreact } from '@sisense/sdk-ui-preact';
2
2
  import type { PropType } from 'vue';
3
3
  import type { WidgetProps } from '../widgets';
4
- export { DashboardConfig, DashboardFiltersPanelConfig };
4
+ export { DashboardFiltersPanelConfig };
5
+ /**
6
+ * Configuration for the dashboard header.
7
+ */
8
+ export interface DashboardHeaderConfig extends Omit<DashboardHeaderConfigPreact, 'items' | 'onBeforeRender'> {
9
+ }
10
+ /**
11
+ * Configuration for the {@link @sisense/sdk-ui-vue!Dashboard | `Dashboard`} component.
12
+ */
13
+ export interface DashboardConfig extends Omit<DashboardConfigPreact, 'header'> {
14
+ /**
15
+ * {@inheritDoc @sisense/sdk-ui!DashboardConfig.header}
16
+ */
17
+ header?: DashboardHeaderConfig;
18
+ }
5
19
  /**
6
20
  * Props of the {@link @sisense/sdk-ui-vue!Dashboard | `Dashboard`} component.
7
21
  */
8
- export interface DashboardProps extends Omit<DashboardPropsPreact, 'widgets'> {
22
+ export interface DashboardProps extends Omit<DashboardPropsPreact, 'widgets' | 'config'> {
9
23
  /**
10
24
  * {@inheritDoc @sisense/sdk-ui!DashboardProps.widgets}
11
25
  */
12
26
  widgets: WidgetProps[];
27
+ /**
28
+ * {@inheritDoc @sisense/sdk-ui!DashboardProps.config}
29
+ */
30
+ config?: DashboardConfig;
13
31
  }
14
32
  /**
15
33
  * A component used for easily rendering a dashboard.
@@ -151,6 +151,12 @@ export declare const ChartWidget: import("vue").DefineComponent<{
151
151
  * @category Widget
152
152
  */
153
153
  styleOptions: PropType<import("@sisense/sdk-ui-preact").ChartWidgetStyleOptions | undefined>;
154
+ /**
155
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.config}
156
+ *
157
+ * @category Widget
158
+ */
159
+ config: PropType<import("@sisense/sdk-ui-preact").WidgetConfig | undefined>;
154
160
  /**
155
161
  * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.title}
156
162
  *
@@ -271,6 +277,12 @@ export declare const ChartWidget: import("vue").DefineComponent<{
271
277
  * @category Widget
272
278
  */
273
279
  styleOptions: PropType<import("@sisense/sdk-ui-preact").ChartWidgetStyleOptions | undefined>;
280
+ /**
281
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.config}
282
+ *
283
+ * @category Widget
284
+ */
285
+ config: PropType<import("@sisense/sdk-ui-preact").WidgetConfig | undefined>;
274
286
  /**
275
287
  * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.title}
276
288
  *
@@ -108,6 +108,19 @@ export declare const Widget: import("vue").DefineComponent<{
108
108
  * @category Widget
109
109
  */
110
110
  styleOptions: PropType<import("@sisense/sdk-ui-preact").TextWidgetStyleOptions | import("@sisense/sdk-ui-preact").CustomWidgetStyleOptions | import("@sisense/sdk-ui-preact").PivotTableWidgetStyleOptions | import("@sisense/sdk-ui-preact").ChartWidgetStyleOptions | undefined>;
111
+ /**
112
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.config}
113
+ *
114
+ * @category Widget
115
+ */
116
+ config: PropType<import("@sisense/sdk-ui-preact").WidgetConfig | undefined>;
117
+ /**
118
+ * {@inheritDoc @sisense/sdk-ui!CustomWidgetProps.customOptions}
119
+ *
120
+ * @category Widget
121
+ * @internal
122
+ */
123
+ customOptions: PropType<Record<string, any> | undefined>;
111
124
  /**
112
125
  * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.drilldownOptions}
113
126
  *
@@ -233,6 +246,19 @@ export declare const Widget: import("vue").DefineComponent<{
233
246
  * @category Widget
234
247
  */
235
248
  styleOptions: PropType<import("@sisense/sdk-ui-preact").TextWidgetStyleOptions | import("@sisense/sdk-ui-preact").CustomWidgetStyleOptions | import("@sisense/sdk-ui-preact").PivotTableWidgetStyleOptions | import("@sisense/sdk-ui-preact").ChartWidgetStyleOptions | undefined>;
249
+ /**
250
+ * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.config}
251
+ *
252
+ * @category Widget
253
+ */
254
+ config: PropType<import("@sisense/sdk-ui-preact").WidgetConfig | undefined>;
255
+ /**
256
+ * {@inheritDoc @sisense/sdk-ui!CustomWidgetProps.customOptions}
257
+ *
258
+ * @category Widget
259
+ * @internal
260
+ */
261
+ customOptions: PropType<Record<string, any> | undefined>;
236
262
  /**
237
263
  * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.drilldownOptions}
238
264
  *
@@ -14,6 +14,6 @@ export { useGetHierarchyModels } from './use-get-hierarchy-models.js';
14
14
  export { useFetch } from './use-fetch.js';
15
15
  export { useCustomWidgets, type CustomWidgetComponent, type CustomWidgetComponentProps, type GenericDataOptions, } from './use-custom-widgets.js';
16
16
  export { useComposedDashboard, type ComposableDashboardProps } from './use-composed-dashboard.js';
17
- export { useJtdWidget } from './use-jtd-widget.js';
17
+ export { useJtdWidget, type JumpToDashboardConfig, type JumpToDashboardConfigForPivot, } from './use-jtd-widget.js';
18
18
  export type { UseFetchOptions } from './use-fetch.js';
19
19
  export type { GetFilterMembersParams, GetFilterMembersData, FilterMembersState, FilterMembersLoadingState, FilterMembersErrorState, FilterMembersSuccessState, } from './use-get-filter-members.js';
@@ -1,9 +1,13 @@
1
1
  import type { Filter, FilterRelations } from '@sisense/sdk-data';
2
2
  import { type ComposableDashboardProps as ComposableDashboardPropsPreact, type UseComposedDashboardOptions, type WidgetsPanelLayout } from '@sisense/sdk-ui-preact';
3
3
  import { type Ref } from 'vue';
4
- import type { DashboardProps } from '../components/dashboard';
4
+ import type { DashboardConfig, DashboardProps } from '../components/dashboard';
5
5
  import type { MaybeRef } from '../types';
6
- export interface ComposableDashboardProps extends ComposableDashboardPropsPreact {
6
+ export interface ComposableDashboardProps extends Omit<ComposableDashboardPropsPreact, 'config'> {
7
+ /**
8
+ * {@inheritDoc @sisense/sdk-ui!DashboardProps.config}
9
+ */
10
+ config?: DashboardConfig;
7
11
  }
8
12
  /**
9
13
  * A Vue composable function `useComposedDashboard` that takes in separate dashboard elements and
@@ -37,9 +37,36 @@ import type { MaybeRefOrWithRefs } from '../types';
37
37
  * - `isError`: Indicates if an error occurred during query execution.
38
38
  * - `isSuccess`: Indicates if the query executed successfully without errors.
39
39
  * - `error`: Contains the error object if an error occurred during the query.
40
+ * - `rowCount`: The total row count of the query result, ignoring the `count` and `offset` paging.
41
+ * Populated only when `includeRowCount` is enabled in the params and the Sisense instance supports
42
+ * the row count API (`@beta`); `undefined` otherwise.
40
43
  *
41
44
  * This composable facilitates integrating Sisense data fetching into Vue applications, enabling developers
42
45
  * to easily manage query states and dynamically adjust query parameters based on application needs.
43
46
  * @group Queries
44
47
  */
45
- export declare const useExecuteQuery: (params: MaybeRefOrWithRefs<ExecuteQueryParams>) => import("vue").ToRefs<import("@sisense/sdk-ui-preact").QueryState>;
48
+ export declare const useExecuteQuery: (params: MaybeRefOrWithRefs<ExecuteQueryParams>) => {
49
+ rowCount: import("vue").Ref<number | undefined>;
50
+ isLoading: import("vue").Ref<true>;
51
+ isError: import("vue").Ref<false>;
52
+ isSuccess: import("vue").Ref<false>;
53
+ error: import("vue").Ref<undefined>;
54
+ data: import("vue").Ref<import("@sisense/sdk-data").QueryResultData | undefined>;
55
+ status: import("vue").Ref<"loading">;
56
+ } | {
57
+ rowCount: import("vue").Ref<number | undefined>;
58
+ isLoading: import("vue").Ref<false>;
59
+ isError: import("vue").Ref<true>;
60
+ isSuccess: import("vue").Ref<false>;
61
+ error: import("vue").Ref<Error>;
62
+ data: import("vue").Ref<undefined>;
63
+ status: import("vue").Ref<"error">;
64
+ } | {
65
+ rowCount: import("vue").Ref<number | undefined>;
66
+ isLoading: import("vue").Ref<false>;
67
+ isError: import("vue").Ref<false>;
68
+ isSuccess: import("vue").Ref<true>;
69
+ error: import("vue").Ref<undefined>;
70
+ data: import("vue").Ref<import("@sisense/sdk-data").QueryResultData>;
71
+ status: import("vue").Ref<"success">;
72
+ };
@@ -1,6 +1,33 @@
1
- import { type JumpToDashboardConfig, type JumpToDashboardConfigForPivot, type WidgetProps } from '@sisense/sdk-ui-preact';
1
+ import { type JumpToDashboardConfigForPivot as JumpToDashboardConfigForPivotPreact, type JumpToDashboardConfig as JumpToDashboardConfigPreact, type WidgetProps } from '@sisense/sdk-ui-preact';
2
2
  import { type Ref } from 'vue';
3
+ import type { DashboardConfig } from '../components/dashboard';
3
4
  import type { MaybeRef, MaybeRefOrWithRefs } from '../types';
5
+ /**
6
+ * Configuration for Jump To Dashboard functionality.
7
+ * Allows users to navigate from a widget to another dashboard with contextual filtering.
8
+ */
9
+ export interface JumpToDashboardConfig extends Omit<JumpToDashboardConfigPreact, 'targetDashboardConfig'> {
10
+ /**
11
+ * {@inheritDoc @sisense/sdk-ui!JumpToDashboardConfig.targetDashboardConfig}
12
+ *
13
+ * @default {}
14
+ */
15
+ targetDashboardConfig?: DashboardConfig;
16
+ }
17
+ /**
18
+ * Configuration for Jump To Dashboard functionality for pivot widgets.
19
+ * Used for pivot widgets, allowing to configure jumping to different dashboard from different dimensions
20
+ *
21
+ * @see {@link JumpToDashboardConfig}
22
+ */
23
+ export interface JumpToDashboardConfigForPivot extends Omit<JumpToDashboardConfigForPivotPreact, 'targetDashboardConfig'> {
24
+ /**
25
+ * {@inheritDoc @sisense/sdk-ui!JumpToDashboardConfig.targetDashboardConfig}
26
+ *
27
+ * @default {}
28
+ */
29
+ targetDashboardConfig?: DashboardConfig;
30
+ }
4
31
  /**
5
32
  * Composable to add Jump To Dashboard (JTD) functionality to individual Widget components.
6
33
  *
@@ -0,0 +1,224 @@
1
+ import type { SisenseContextProviderProps as SisenseContextProviderPropsPreact } from '@sisense/sdk-ui-preact';
2
+ import type { PropType } from 'vue';
3
+ /**
4
+ * Configurations and authentication for Sisense Context.
5
+ *
6
+ * Use one of the following to authenticate:
7
+ *
8
+ * - {@link @sisense/sdk-ui-vue!SisenseContextProviderProps.ssoEnabled | `ssoEnabled`}
9
+ * - {@link @sisense/sdk-ui-vue!SisenseContextProviderProps.token | `token`}
10
+ * - {@link @sisense/sdk-ui-vue!SisenseContextProviderProps.wat | `wat`}
11
+ */
12
+ export interface SisenseContextProviderProps extends Omit<SisenseContextProviderPropsPreact, 'modules'> {
13
+ }
14
+ /**
15
+ * Sisense Context Provider Component allowing you to connect to
16
+ * a Sisense instance and provide that context
17
+ * to all Compose SDK components in your application.
18
+ *
19
+ * @example
20
+ * Here's how to use the `SisenseContextProvider` component to wrap your Sisense-enabled application:
21
+ * Add SisenseContextProvider to the main component of your app as below and then wrap
22
+ * other SDK components inside this component.
23
+ * ```vue
24
+ * <template>
25
+ * <SisenseContextProvider
26
+ * :url="sisenseUrl"
27
+ * :defaultDataSource="defaultDataSource"
28
+ * :ssoEnabled="true"
29
+ * :token="authToken"
30
+ * :wat="watToken"
31
+ * :appConfig="appConfigurations"
32
+ * >
33
+ * <!-- Your application components here -->
34
+ * </SisenseContextProvider>
35
+ * </template>
36
+ *
37
+ * <script>
38
+ * import { ref } from 'vue';
39
+ * import SisenseContextProvider from './SisenseContextProvider.vue';
40
+ *
41
+ * export default {
42
+ * components: { SisenseContextProvider },
43
+ * setup() {
44
+ * const sisenseUrl = ref('https://your-sisense-instance.com');
45
+ * const defaultDataSource = ref('default_datasource_id');
46
+ * const authToken = ref('your_auth_token');
47
+ * const watToken = ref('your_wat_token');
48
+ * const appConfigurations = ref({});
49
+ *
50
+ * return { sisenseUrl, defaultDataSource, authToken, watToken, appConfigurations };
51
+ * }
52
+ * };
53
+ * </script>
54
+ * ```
55
+ *
56
+ * @param props - Sisense context provider props
57
+ * @returns A Sisense Context Provider Component
58
+ * @group Contexts
59
+ */
60
+ export declare const SisenseContextProvider: import("vue").DefineComponent<{
61
+ /**
62
+ * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.defaultDataSource}
63
+ *
64
+ * @category Sisense App
65
+ */
66
+ defaultDataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
67
+ /**
68
+ * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.url}
69
+ *
70
+ * @category Sisense App
71
+ */
72
+ url: {
73
+ type: PropType<string>;
74
+ required: true;
75
+ };
76
+ /**
77
+ * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoEnabled}
78
+ *
79
+ * @category Sisense Authentication
80
+ */
81
+ ssoEnabled: PropType<boolean | undefined>;
82
+ /**
83
+ * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.enableSilentPreAuth}
84
+ *
85
+ * @category Sisense Authentication
86
+ */
87
+ enableSilentPreAuth: {
88
+ type: PropType<boolean | undefined>;
89
+ default: boolean;
90
+ };
91
+ /**
92
+ * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.token}
93
+ *
94
+ * @category Sisense Authentication
95
+ */
96
+ token: PropType<string | null | undefined>;
97
+ /**
98
+ * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.wat}
99
+ *
100
+ * @category Sisense Authentication
101
+ */
102
+ wat: PropType<string | null | undefined>;
103
+ /**
104
+ * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.appConfig}
105
+ *
106
+ * @category Sisense App
107
+ */
108
+ appConfig: PropType<import("@sisense/sdk-ui-preact").AppConfig | undefined>;
109
+ /**
110
+ * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.plugins}
111
+ *
112
+ * @category Sisense App
113
+ * @internal
114
+ */
115
+ plugins: {
116
+ type: PropType<import("@sisense/sdk-ui-preact").Plugin[] | undefined>;
117
+ default: () => never[];
118
+ };
119
+ /**
120
+ * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoMaxAuthRedirectAttempts}
121
+ *
122
+ * @category Sisense Authentication
123
+ * @alpha
124
+ */
125
+ ssoMaxAuthRedirectAttempts: PropType<number | undefined>;
126
+ /**
127
+ * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoRedirectAttemptsTtlMs}
128
+ *
129
+ * @category Sisense Authentication
130
+ * @alpha
131
+ */
132
+ ssoRedirectAttemptsTtlMs: PropType<number | undefined>;
133
+ /**
134
+ * @internal
135
+ */
136
+ showRuntimeErrors: {
137
+ type: PropType<boolean | undefined>;
138
+ default: boolean;
139
+ };
140
+ }, () => import("vue/jsx-runtime").JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
141
+ /**
142
+ * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.defaultDataSource}
143
+ *
144
+ * @category Sisense App
145
+ */
146
+ defaultDataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
147
+ /**
148
+ * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.url}
149
+ *
150
+ * @category Sisense App
151
+ */
152
+ url: {
153
+ type: PropType<string>;
154
+ required: true;
155
+ };
156
+ /**
157
+ * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoEnabled}
158
+ *
159
+ * @category Sisense Authentication
160
+ */
161
+ ssoEnabled: PropType<boolean | undefined>;
162
+ /**
163
+ * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.enableSilentPreAuth}
164
+ *
165
+ * @category Sisense Authentication
166
+ */
167
+ enableSilentPreAuth: {
168
+ type: PropType<boolean | undefined>;
169
+ default: boolean;
170
+ };
171
+ /**
172
+ * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.token}
173
+ *
174
+ * @category Sisense Authentication
175
+ */
176
+ token: PropType<string | null | undefined>;
177
+ /**
178
+ * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.wat}
179
+ *
180
+ * @category Sisense Authentication
181
+ */
182
+ wat: PropType<string | null | undefined>;
183
+ /**
184
+ * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.appConfig}
185
+ *
186
+ * @category Sisense App
187
+ */
188
+ appConfig: PropType<import("@sisense/sdk-ui-preact").AppConfig | undefined>;
189
+ /**
190
+ * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.plugins}
191
+ *
192
+ * @category Sisense App
193
+ * @internal
194
+ */
195
+ plugins: {
196
+ type: PropType<import("@sisense/sdk-ui-preact").Plugin[] | undefined>;
197
+ default: () => never[];
198
+ };
199
+ /**
200
+ * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoMaxAuthRedirectAttempts}
201
+ *
202
+ * @category Sisense Authentication
203
+ * @alpha
204
+ */
205
+ ssoMaxAuthRedirectAttempts: PropType<number | undefined>;
206
+ /**
207
+ * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoRedirectAttemptsTtlMs}
208
+ *
209
+ * @category Sisense Authentication
210
+ * @alpha
211
+ */
212
+ ssoRedirectAttemptsTtlMs: PropType<number | undefined>;
213
+ /**
214
+ * @internal
215
+ */
216
+ showRuntimeErrors: {
217
+ type: PropType<boolean | undefined>;
218
+ default: boolean;
219
+ };
220
+ }>>, {
221
+ plugins: import("@sisense/sdk-ui-preact").Plugin[] | undefined;
222
+ showRuntimeErrors: boolean | undefined;
223
+ enableSilentPreAuth: boolean | undefined;
224
+ }, {}>;
@@ -1,2 +1,2 @@
1
1
  export { boxWhiskerProcessResult, extractDimensionsAndMeasures, formatNumber, formatDate, getDefaultDateFormat, formatDataSet, } from '@sisense/sdk-ui-preact';
2
- export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, CalendarHeatmapChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, CalendarHeatmapSubtype, WidgetType, CartesianWidgetType, CategoricalWidgetType, TabularWidgetType, ExecuteQueryByWidgetIdParams, ExecuteQueryParams, GetWidgetModelParams, GetSharedFormulaParams, GetDashboardModelParams, UseGetSharedFormulaParams, GetDashboardModelsParams, GetHierarchyModelsParams, CommonDataOptions, FormatDateOptions, FormatDataSetOptions, ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, BoxplotChartDataOptions, BoxplotChartCustomDataOptions, CalendarHeatmapChartDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, TableDataOptions, PivotTableDataOptions, WidgetDataOptions, NumberFormatConfig, DecimalScale, DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, ValueToColorMap, MultiColumnValueToColorMap, SortDirection, BoxWhiskerType, ScattermapLocationLevel, StyledColumn, StyledMeasureColumn, PivotRowsSort, DataOptionLocation, ChartStyleOptions, LineStyleOptions, AreaStyleOptions, StackableStyleOptions, PieStyleOptions, FunnelStyleOptions, PolarStyleOptions, IndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, NumericBarIndicatorStyleOptions, GaugeIndicatorStyleOptions, ScatterStyleOptions, TreemapStyleOptions, StreamgraphStyleOptions, SunburstStyleOptions, BoxplotStyleOptions, CalendarHeatmapStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, ChartWidgetStyleOptions, WidgetStyleOptions, WidgetByIdStyleOptions, TableStyleOptions, PivotTableStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, LineOptions, DashStyle, EndCapType, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, CalendarHeatmapViewType, WidgetModel, DashboardModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, CalendarHeatmapDataPoint, CalendarDayOfWeek, IndicatorBeforeRenderHandler, IndicatorRenderOptions, DashboardLayoutOptions, WidgetsPanelLayout, WidgetsPanelColumnLayout, WidgetId, JumpToDashboardConfig, JumpToDashboardConfigForPivot, WidgetsOptions, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, PivotTableDrilldownOptions, PivotTableSelectableDrilldownOptions, PivotTableNonSelectableDrilldownOptions, Member, FilterVariant, TranslationConfig, Plugin, } from '@sisense/sdk-ui-preact';
2
+ export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, CalendarHeatmapChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, CalendarHeatmapSubtype, WidgetType, CartesianWidgetType, CategoricalWidgetType, TabularWidgetType, ExecuteQueryByWidgetIdParams, ExecuteQueryParams, GetWidgetModelParams, GetSharedFormulaParams, GetDashboardModelParams, UseGetSharedFormulaParams, GetDashboardModelsParams, GetHierarchyModelsParams, CommonDataOptions, FormatDateOptions, FormatDataSetOptions, ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, BoxplotChartDataOptions, BoxplotChartCustomDataOptions, CalendarHeatmapChartDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, TableDataOptions, PivotTableDataOptions, WidgetDataOptions, NumberFormatConfig, DecimalScale, DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, ValueToColorMap, MultiColumnValueToColorMap, SortDirection, BoxWhiskerType, ScattermapLocationLevel, StyledColumn, StyledMeasureColumn, PivotRowsSort, DataOptionLocation, ChartStyleOptions, LineStyleOptions, AreaStyleOptions, StackableStyleOptions, PieStyleOptions, FunnelStyleOptions, PolarStyleOptions, IndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, NumericBarIndicatorStyleOptions, GaugeIndicatorStyleOptions, ScatterStyleOptions, TreemapStyleOptions, StreamgraphStyleOptions, SunburstStyleOptions, BoxplotStyleOptions, CalendarHeatmapStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, ChartWidgetStyleOptions, WidgetStyleOptions, WidgetByIdStyleOptions, TableStyleOptions, PivotTableStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, LineOptions, DashStyle, EndCapType, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, CalendarHeatmapViewType, WidgetModel, DashboardModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, CalendarHeatmapDataPoint, CalendarDayOfWeek, IndicatorBeforeRenderHandler, IndicatorRenderOptions, DashboardLayoutOptions, WidgetsPanelLayout, WidgetsPanelColumnLayout, WidgetId, WidgetsOptions, WidgetConfig, WidgetNarrativeConfig, WidgetNarrativeDisplayLocation, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, PivotTableDrilldownOptions, PivotTableSelectableDrilldownOptions, PivotTableNonSelectableDrilldownOptions, Member, FilterVariant, TranslationConfig, Plugin, } from '@sisense/sdk-ui-preact';
@@ -1 +1 @@
1
- export * from '../packages/sdk-ui-vue/src/translation/__external__/de-de'
1
+ export * from '../src/translation/__external__/de-de'
@@ -1 +1 @@
1
- export * from '../packages/sdk-ui-vue/src/translation/__external__/en-us'
1
+ export * from '../src/translation/__external__/en-us'
@@ -1 +1 @@
1
- export * from '../packages/sdk-ui-vue/src/translation/__external__/es-ar'
1
+ export * from '../src/translation/__external__/es-ar'
@@ -1 +1 @@
1
- export * from '../packages/sdk-ui-vue/src/translation/__external__/es-es'
1
+ export * from '../src/translation/__external__/es-es'
@@ -1 +1 @@
1
- export * from '../packages/sdk-ui-vue/src/translation/__external__/fr-fr'
1
+ export * from '../src/translation/__external__/fr-fr'
@@ -1 +1 @@
1
- export * from '../packages/sdk-ui-vue/src/translation/__external__/it-it'
1
+ export * from '../src/translation/__external__/it-it'
@@ -1 +1 @@
1
- export * from '../packages/sdk-ui-vue/src/translation/__external__/ja-jp'
1
+ export * from '../src/translation/__external__/ja-jp'
@@ -1 +1 @@
1
- export * from '../packages/sdk-ui-vue/src/translation/__external__/ko-kr'
1
+ export * from '../src/translation/__external__/ko-kr'
@@ -1 +1 @@
1
- export * from '../packages/sdk-ui-vue/src/translation/__external__/nl-nl'
1
+ export * from '../src/translation/__external__/nl-nl'
@@ -1 +1 @@
1
- export * from '../packages/sdk-ui-vue/src/translation/__external__/pt-br'
1
+ export * from '../src/translation/__external__/pt-br'
@@ -1 +1 @@
1
- export * from '../packages/sdk-ui-vue/src/translation/__external__/ru-ru'
1
+ export * from '../src/translation/__external__/ru-ru'
@@ -1 +1 @@
1
- export * from '../packages/sdk-ui-vue/src/translation/__external__/tr-tr'
1
+ export * from '../src/translation/__external__/tr-tr'
@@ -1 +1 @@
1
- export * from '../packages/sdk-ui-vue/src/translation/__external__/zh-cn'
1
+ export * from '../src/translation/__external__/zh-cn'