@sisense/sdk-ui-vue 2.28.0 → 2.30.0

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

@@ -151,6 +151,12 @@ export declare const ChartWidget: import("vue").DefineComponent<{
      * @category Widget
      */
     styleOptions: PropType<import("@sisense/sdk-ui-preact").ChartWidgetStyleOptions | undefined>;
+    /**
+     * Configuration for AI-powered widget features such as automated narrative generation
+     * @alpha
+     * @category Widget
+     */
+    aiOptions: PropType<import("@sisense/sdk-ui-preact").WidgetAiOptions | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.title}
      *
@@ -271,6 +277,12 @@ export declare const ChartWidget: import("vue").DefineComponent<{
      * @category Widget
      */
     styleOptions: PropType<import("@sisense/sdk-ui-preact").ChartWidgetStyleOptions | undefined>;
+    /**
+     * Configuration for AI-powered widget features such as automated narrative generation
+     * @alpha
+     * @category Widget
+     */
+    aiOptions: PropType<import("@sisense/sdk-ui-preact").WidgetAiOptions | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.title}
      *

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

@@ -3,6 +3,13 @@ import type { PropType } from 'vue';
 export { WithCommonWidgetProps, TextWidgetProps, CustomWidgetProps };
 export interface PivotTableWidgetProps extends PivotTableWidgetPropsPreact {
 }
+/**
+ * Configuration for AI-powered widget features such as automated narrative generation.
+ * Shared by chart and pivot {@link Widget} instances.
+ *
+ * @alpha
+ */
+export type WidgetAiOptions = NonNullable<ChartWidgetProps['aiOptions']>;
 /**
  * Props of the {@link @sisense/sdk-ui-vue!Widget | `Widget`} component.
  */
@@ -108,6 +115,12 @@ export declare const Widget: import("vue").DefineComponent<{
      * @category Widget
      */
     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>;
+    /**
+     * Configuration for AI-powered widget features such as automated narrative generation
+     * @alpha
+     * @category Widget
+     */
+    aiOptions: PropType<import("@sisense/sdk-ui-preact").WidgetAiOptions>;
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.drilldownOptions}
      *
@@ -233,6 +246,12 @@ export declare const Widget: import("vue").DefineComponent<{
      * @category Widget
      */
     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>;
+    /**
+     * Configuration for AI-powered widget features such as automated narrative generation
+     * @alpha
+     * @category Widget
+     */
+    aiOptions: PropType<import("@sisense/sdk-ui-preact").WidgetAiOptions>;
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.drilldownOptions}
      *

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

@@ -37,9 +37,36 @@ import type { MaybeRefOrWithRefs } from '../types';
  * - `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.
+ * - `rowCount`: The total row count of the query result, ignoring the `count` and `offset` paging.
+ * Populated only when `includeRowCount` is enabled in the params and the Sisense instance supports
+ * the row count API (`@beta`); `undefined` otherwise.
  *
  * 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: MaybeRefOrWithRefs<ExecuteQueryParams>) => import("vue").ToRefs<import("@sisense/sdk-ui-preact").QueryState>;
+export declare const useExecuteQuery: (params: MaybeRefOrWithRefs<ExecuteQueryParams>) => {
+    rowCount: import("vue").Ref<number | undefined>;
+    isLoading: import("vue").Ref<true>;
+    isError: import("vue").Ref<false>;
+    isSuccess: import("vue").Ref<false>;
+    error: import("vue").Ref<undefined>;
+    data: import("vue").Ref<import("@sisense/sdk-data").QueryResultData | undefined>;
+    status: import("vue").Ref<"loading">;
+} | {
+    rowCount: import("vue").Ref<number | undefined>;
+    isLoading: import("vue").Ref<false>;
+    isError: import("vue").Ref<true>;
+    isSuccess: import("vue").Ref<false>;
+    error: import("vue").Ref<Error>;
+    data: import("vue").Ref<undefined>;
+    status: import("vue").Ref<"error">;
+} | {
+    rowCount: import("vue").Ref<number | undefined>;
+    isLoading: import("vue").Ref<false>;
+    isError: import("vue").Ref<false>;
+    isSuccess: import("vue").Ref<true>;
+    error: import("vue").Ref<undefined>;
+    data: import("vue").Ref<import("@sisense/sdk-data").QueryResultData>;
+    status: import("vue").Ref<"success">;
+};

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

@@ -0,0 +1,224 @@
+import type { SisenseContextProviderProps as SisenseContextProviderPropsPreact } from '@sisense/sdk-ui-preact';
+import type { PropType } from 'vue';
+/**
+ * Configurations and authentication for Sisense Context.
+ *
+ * Use one of the following to authenticate:
+ *
+ * - {@link @sisense/sdk-ui-vue!SisenseContextProviderProps.ssoEnabled | `ssoEnabled`}
+ * - {@link @sisense/sdk-ui-vue!SisenseContextProviderProps.token | `token`}
+ * - {@link @sisense/sdk-ui-vue!SisenseContextProviderProps.wat | `wat`}
+ */
+export interface SisenseContextProviderProps extends SisenseContextProviderPropsPreact {
+}
+/**
+ * Sisense Context Provider Component allowing you to connect to
+ * a Sisense instance and provide that context
+ * to all Compose SDK components in your application.
+ *
+ * @example
+ * Here's how to use the `SisenseContextProvider` component to wrap your Sisense-enabled application:
+ * Add SisenseContextProvider to the main component of your app as below and then wrap
+ * other SDK components inside this component.
+ * ```vue
+ * <template>
+ *   <SisenseContextProvider
+ *     :url="sisenseUrl"
+ *     :defaultDataSource="defaultDataSource"
+ *     :ssoEnabled="true"
+ *     :token="authToken"
+ *     :wat="watToken"
+ *     :appConfig="appConfigurations"
+ *   >
+ *     <!-- Your application components here -->
+ *   </SisenseContextProvider>
+ * </template>
+ *
+ * <script>
+ * import { ref } from 'vue';
+ * import SisenseContextProvider from './SisenseContextProvider.vue';
+ *
+ * export default {
+ *   components: { SisenseContextProvider },
+ *   setup() {
+ *     const sisenseUrl = ref('https://your-sisense-instance.com');
+ *     const defaultDataSource = ref('default_datasource_id');
+ *     const authToken = ref('your_auth_token');
+ *     const watToken = ref('your_wat_token');
+ *     const appConfigurations = ref({});
+ *
+ *     return { sisenseUrl, defaultDataSource, authToken, watToken, appConfigurations };
+ *   }
+ * };
+ * </script>
+ * ```
+ *
+ * @param props - Sisense context provider props
+ * @returns A Sisense Context Provider Component
+ * @group Contexts
+ */
+export declare const SisenseContextProvider: import("vue").DefineComponent<{
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.defaultDataSource}
+     *
+     * @category Sisense App
+     */
+    defaultDataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.url}
+     *
+     * @category Sisense App
+     */
+    url: {
+        type: PropType<string>;
+        required: true;
+    };
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoEnabled}
+     *
+     * @category Sisense Authentication
+     */
+    ssoEnabled: PropType<boolean | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.enableSilentPreAuth}
+     *
+     * @category Sisense Authentication
+     */
+    enableSilentPreAuth: {
+        type: PropType<boolean | undefined>;
+        default: boolean;
+    };
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.token}
+     *
+     * @category Sisense Authentication
+     */
+    token: PropType<string | null | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.wat}
+     *
+     * @category Sisense Authentication
+     */
+    wat: PropType<string | null | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.appConfig}
+     *
+     * @category Sisense App
+     */
+    appConfig: PropType<import("@sisense/sdk-ui-preact").AppConfig | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.plugins}
+     *
+     * @category Sisense App
+     * @internal
+     */
+    plugins: {
+        type: PropType<import("@sisense/sdk-ui-preact").Plugin[] | undefined>;
+        default: () => never[];
+    };
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoMaxAuthRedirectAttempts}
+     *
+     * @category Sisense Authentication
+     * @alpha
+     */
+    ssoMaxAuthRedirectAttempts: PropType<number | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoRedirectAttemptsTtlMs}
+     *
+     * @category Sisense Authentication
+     * @alpha
+     */
+    ssoRedirectAttemptsTtlMs: PropType<number | undefined>;
+    /**
+     * @internal
+     */
+    showRuntimeErrors: {
+        type: PropType<boolean | undefined>;
+        default: boolean;
+    };
+}, () => 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}
+     *
+     * @category Sisense App
+     */
+    defaultDataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.url}
+     *
+     * @category Sisense App
+     */
+    url: {
+        type: PropType<string>;
+        required: true;
+    };
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoEnabled}
+     *
+     * @category Sisense Authentication
+     */
+    ssoEnabled: PropType<boolean | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.enableSilentPreAuth}
+     *
+     * @category Sisense Authentication
+     */
+    enableSilentPreAuth: {
+        type: PropType<boolean | undefined>;
+        default: boolean;
+    };
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.token}
+     *
+     * @category Sisense Authentication
+     */
+    token: PropType<string | null | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.wat}
+     *
+     * @category Sisense Authentication
+     */
+    wat: PropType<string | null | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.appConfig}
+     *
+     * @category Sisense App
+     */
+    appConfig: PropType<import("@sisense/sdk-ui-preact").AppConfig | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.plugins}
+     *
+     * @category Sisense App
+     * @internal
+     */
+    plugins: {
+        type: PropType<import("@sisense/sdk-ui-preact").Plugin[] | undefined>;
+        default: () => never[];
+    };
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoMaxAuthRedirectAttempts}
+     *
+     * @category Sisense Authentication
+     * @alpha
+     */
+    ssoMaxAuthRedirectAttempts: PropType<number | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoRedirectAttemptsTtlMs}
+     *
+     * @category Sisense Authentication
+     * @alpha
+     */
+    ssoRedirectAttemptsTtlMs: PropType<number | undefined>;
+    /**
+     * @internal
+     */
+    showRuntimeErrors: {
+        type: PropType<boolean | undefined>;
+        default: boolean;
+    };
+}>>, {
+    plugins: import("@sisense/sdk-ui-preact").Plugin[] | undefined;
+    enableSilentPreAuth: boolean | undefined;
+    showRuntimeErrors: boolean | undefined;
+}, {}>;

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

@@ -1,2 +1,2 @@
-export { boxWhiskerProcessResult, extractDimensionsAndMeasures } from '@sisense/sdk-ui-preact';
-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, 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';
+export { boxWhiskerProcessResult, extractDimensionsAndMeasures, formatNumber, formatDate, getDefaultDateFormat, formatDataSet, } from '@sisense/sdk-ui-preact';
+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';

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "2.28.0",
+  "version": "2.30.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -72,8 +72,8 @@
     "clean": "rm -rf ./dist && rm -rf ./coverage && rm -rf tsconfig.tsbuildinfo"
   },
   "dependencies": {
-    "@sisense/sdk-data": "2.28.0",
-    "@sisense/sdk-ui-preact": "2.28.0",
+    "@sisense/sdk-data": "2.30.0",
+    "@sisense/sdk-ui-preact": "2.30.0",
     "deepmerge": "^4.3.1",
     "lodash-es": "^4.17.21",
     "vue": "^3.3.2"