@sisense/sdk-ui-vue 2.34.0 → 2.36.0

package/dist/src/components/widgets/widget.d.ts

@@ -1,12 +1,48 @@
-import type { ChartWidgetProps, CustomWidgetProps, FilterWidgetProps, PivotTableWidgetProps as PivotTableWidgetPropsPreact, SoftUnion, TextWidgetProps, WithCommonWidgetProps } from '@sisense/sdk-ui-preact';
+import type { CustomWidgetProps as CustomWidgetPropsPreact, FilterWidgetProps as FilterWidgetPropsPreact, NarrativeWidgetProps, SoftUnion, TextWidgetProps as TextWidgetPropsPreact, WithCommonWidgetProps } from '@sisense/sdk-ui-preact';
 import type { PropType } from 'vue';
-export { WithCommonWidgetProps, TextWidgetProps, CustomWidgetProps };
-export interface PivotTableWidgetProps extends PivotTableWidgetPropsPreact {
+import type { ChartWidgetProps } from './chart-widget';
+import type { PivotTableWidgetProps } from './pivot-table-widget';
+import type { CustomWidgetConfig, FilterWidgetConfig, TextWidgetConfig } from './widget-config';
+export { WithCommonWidgetProps };
+/**
+ * Props for the text widget component.
+ */
+export interface TextWidgetProps extends Omit<TextWidgetPropsPreact, 'config'> {
+    /**
+     * {@inheritDoc @sisense/sdk-ui!TextWidgetProps.config}
+     *
+     * @category Widget
+     */
+    config?: TextWidgetConfig;
+}
+/**
+ * Props for the custom widget component
+ */
+export interface CustomWidgetProps extends Omit<CustomWidgetPropsPreact, 'config'> {
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CustomWidgetProps.config}
+     *
+     * @category Widget
+     */
+    config?: CustomWidgetConfig;
+}
+/**
+ * Props for the filter widget component.
+ *
+ * @beta
+ */
+export interface FilterWidgetProps extends Omit<FilterWidgetPropsPreact, 'config'> {
+    /**
+     * {@inheritDoc @sisense/sdk-ui!FilterWidgetProps.config}
+     *
+     * @category Widget
+     */
+    config?: FilterWidgetConfig;
 }
 /**
  * Props of the {@link @sisense/sdk-ui-vue!Widget | `Widget`} component.
  */
-export type WidgetProps = SoftUnion<WithCommonWidgetProps<ChartWidgetProps, 'chart'> | WithCommonWidgetProps<PivotTableWidgetProps, 'pivot'> | WithCommonWidgetProps<TextWidgetProps, 'text'> | WithCommonWidgetProps<CustomWidgetProps, 'custom'> | WithCommonWidgetProps<FilterWidgetProps, 'filter'>>;
+export type WidgetProps = SoftUnion<WithCommonWidgetProps<ChartWidgetProps, 'chart'> | WithCommonWidgetProps<PivotTableWidgetProps, 'pivot'> | WithCommonWidgetProps<TextWidgetProps, 'text'> | WithCommonWidgetProps<CustomWidgetProps, 'custom'> | WithCommonWidgetProps<FilterWidgetProps, 'filter'> | WithCommonWidgetProps<NarrativeWidgetProps, 'narrative'>>;
 /**
  * Facade component that renders a widget within a dashboard based on the widget type.
  *
@@ -63,7 +99,7 @@ export declare const Widget: import("vue").DefineComponent<{
      * @category Widget
      */
     widgetType: {
-        type: PropType<"filter" | "text" | "custom" | "chart" | "pivot">;
+        type: PropType<"filter" | "text" | "custom" | "chart" | "pivot" | "narrative">;
         required: true;
     };
     /**
@@ -107,13 +143,13 @@ export declare const Widget: import("vue").DefineComponent<{
      *
      * @category Widget
      */
-    styleOptions: PropType<import("@sisense/sdk-ui-preact").WidgetContainerStyleOptions | import("@sisense/sdk-ui-preact").CustomWidgetStyleOptions | import("@sisense/sdk-ui-preact").ChartWidgetStyleOptions | import("@sisense/sdk-ui-preact").PivotTableWidgetStyleOptions | import("@sisense/sdk-ui-preact").TextWidgetStyleOptions | undefined>;
+    styleOptions: PropType<import("@sisense/sdk-ui-preact").WidgetContainerStyleOptions | import("@sisense/sdk-ui-preact").CustomWidgetStyleOptions | import("@sisense/sdk-ui-preact").TextWidgetStyleOptions | import("@sisense/sdk-ui-preact").ChartWidgetStyleOptions | import("@sisense/sdk-ui-preact").PivotTableWidgetStyleOptions | import("@sisense/sdk-ui-preact").FilterWidgetStyleOptions | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.config}
      *
      * @category Widget
      */
-    config: PropType<import("@sisense/sdk-ui-preact").ChartWidgetConfig | import("@sisense/sdk-ui-preact").PivotTableWidgetConfig | import("@sisense/sdk-ui-preact").TextWidgetConfig | import("@sisense/sdk-ui-preact").CustomWidgetConfig | import("@sisense/sdk-ui-preact").FilterWidgetConfig | undefined>;
+    config: PropType<import("@sisense/sdk-ui-preact").NarrativeWidgetConfig | import("./widget-config").ChartWidgetConfig | import("./widget-config").PivotTableWidgetConfig | CustomWidgetConfig | TextWidgetConfig | FilterWidgetConfig | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!CustomWidgetProps.customOptions}
      *
@@ -201,7 +237,7 @@ export declare const Widget: import("vue").DefineComponent<{
      * @category Widget
      */
     widgetType: {
-        type: PropType<"filter" | "text" | "custom" | "chart" | "pivot">;
+        type: PropType<"filter" | "text" | "custom" | "chart" | "pivot" | "narrative">;
         required: true;
     };
     /**
@@ -245,13 +281,13 @@ export declare const Widget: import("vue").DefineComponent<{
      *
      * @category Widget
      */
-    styleOptions: PropType<import("@sisense/sdk-ui-preact").WidgetContainerStyleOptions | import("@sisense/sdk-ui-preact").CustomWidgetStyleOptions | import("@sisense/sdk-ui-preact").ChartWidgetStyleOptions | import("@sisense/sdk-ui-preact").PivotTableWidgetStyleOptions | import("@sisense/sdk-ui-preact").TextWidgetStyleOptions | undefined>;
+    styleOptions: PropType<import("@sisense/sdk-ui-preact").WidgetContainerStyleOptions | import("@sisense/sdk-ui-preact").CustomWidgetStyleOptions | import("@sisense/sdk-ui-preact").TextWidgetStyleOptions | import("@sisense/sdk-ui-preact").ChartWidgetStyleOptions | import("@sisense/sdk-ui-preact").PivotTableWidgetStyleOptions | import("@sisense/sdk-ui-preact").FilterWidgetStyleOptions | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.config}
      *
      * @category Widget
      */
-    config: PropType<import("@sisense/sdk-ui-preact").ChartWidgetConfig | import("@sisense/sdk-ui-preact").PivotTableWidgetConfig | import("@sisense/sdk-ui-preact").TextWidgetConfig | import("@sisense/sdk-ui-preact").CustomWidgetConfig | import("@sisense/sdk-ui-preact").FilterWidgetConfig | undefined>;
+    config: PropType<import("@sisense/sdk-ui-preact").NarrativeWidgetConfig | import("./widget-config").ChartWidgetConfig | import("./widget-config").PivotTableWidgetConfig | CustomWidgetConfig | TextWidgetConfig | FilterWidgetConfig | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!CustomWidgetProps.customOptions}
      *

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

@@ -1,4 +1,5 @@
-import type { GetWidgetModelParams, WidgetModel } from '@sisense/sdk-ui-preact';
+import type { GetWidgetModelParams } from '@sisense/sdk-ui-preact';
+import type { WidgetModel } from '../components/widgets/widget-model';
 import type { MaybeRefOrWithRefs } from '../types';
 /**
  * A Vue composable function `useGetWidgetModel` for retrieving widget models from a Sisense dashboard.

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

@@ -1,3 +1,3 @@
 export { boxWhiskerProcessResult, extractDimensionsAndMeasures, formatNumber, formatDate, getDefaultDateFormat, formatDataSet, } from '@sisense/sdk-ui-preact';
 export { WidgetHeaderMenuTargets } from '@sisense/sdk-ui-preact';
-export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, KpiChartType, CalendarHeatmapChartType, ScattermapChartType, AreamapChartType, SankeyChartType, 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, KpiChartDataOptions, KpiComparison, KpiValueMode, ScattermapChartDataOptions, AreamapChartDataOptions, SankeyChartDataOptions, 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, KpiStyleOptions, KpiValueStyleOptions, KpiTitleStyleOptions, KpiComparisonStyleOptions, KpiSparklineStyleOptions, KpiSparklineType, KpiCardStyleOptions, KpiTextSize, KpiIconCondition, KpiIcon, KpiIconName, ScattermapStyleOptions, AreamapStyleOptions, SankeyStyleOptions, 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, KpiBeforeRenderHandler, KpiRenderOptions, KpiDataPoint, KpiComparisonInfo, KpiDataPointEventHandler, DashboardLayoutOptions, WidgetsPanelLayout, WidgetsPanelColumnLayout, WidgetId, WidgetsOptions, WidgetConfig, ChartWidgetConfig, PivotTableWidgetConfig, CustomWidgetConfig, TextWidgetConfig, FilterWidgetConfig, WidgetHeaderConfig, WidgetHeaderMenuActionItem, WidgetHeaderMenuConfig, WidgetHeaderMenuItem, WidgetHeaderMenuSubmenuItem, WidgetHeaderMenuTarget, WidgetNarrativeConfig, WidgetNarrativeDisplayLocation, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, PivotTableDrilldownOptions, PivotTableSelectableDrilldownOptions, PivotTableNonSelectableDrilldownOptions, Member, FilterVariant, FilterWidgetProps, FilterWidgetFilterType, TranslationConfig, Plugin, } from '@sisense/sdk-ui-preact';
+export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, KpiChartType, CalendarHeatmapChartType, ScattermapChartType, AreamapChartType, SankeyChartType, 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, KpiChartDataOptions, KpiComparison, KpiValueMode, ScattermapChartDataOptions, AreamapChartDataOptions, SankeyChartDataOptions, 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, KpiStyleOptions, KpiValueStyleOptions, KpiTitleStyleOptions, KpiTitleAlign, KpiComparisonStyleOptions, KpiSparklineStyleOptions, KpiSparklineType, KpiCardStyleOptions, KpiTextSize, KpiIconCondition, KpiIcon, KpiIconName, ScattermapStyleOptions, AreamapStyleOptions, SankeyStyleOptions, ChartWidgetStyleOptions, WidgetStyleOptions, WidgetByIdStyleOptions, TableStyleOptions, PivotTableStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, LineOptions, DashStyle, EndCapType, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, CalendarHeatmapViewType, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, CalendarHeatmapDataPoint, CalendarDayOfWeek, IndicatorBeforeRenderHandler, IndicatorRenderOptions, KpiBeforeRenderHandler, KpiRenderOptions, KpiDataPoint, KpiComparisonInfo, KpiDataPointEventHandler, DashboardLayoutOptions, WidgetsPanelLayout, WidgetsPanelColumnLayout, WidgetId, WidgetsOptions, WidgetHeaderMenuActionItem, WidgetHeaderMenuConfig, WidgetHeaderMenuItem, WidgetHeaderMenuSubmenuItem, WidgetHeaderMenuTarget, WidgetNarrativeConfig, WidgetNarrativeDisplayLocation, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, PivotTableDrilldownOptions, PivotTableSelectableDrilldownOptions, PivotTableNonSelectableDrilldownOptions, Member, FilterVariant, FilterWidgetFilterType, NarrativeWidgetProps, TranslationConfig, Plugin, } from '@sisense/sdk-ui-preact';

package/dist/src/utilities/dashboard-model-translator.d.ts

@@ -1,5 +1,5 @@
-import { type DashboardModel } from '@sisense/sdk-ui-preact';
 import type { DashboardProps } from '../components/dashboard';
+import type { DashboardModel } from '../components/dashboard/dashboard-model';
 /**
  * Translates {@link DashboardModel} to {@link DashboardProps}.
  *

package/dist/src/utilities/widget-model-translator.d.ts

@@ -1,6 +1,9 @@
-import { type ExecutePivotQueryParams, type ExecuteQueryParams, type PivotTableWidgetProps, type TextWidgetProps, type WidgetModel } from '@sisense/sdk-ui-preact';
+import { type ExecutePivotQueryParams, type ExecuteQueryParams } from '@sisense/sdk-ui-preact';
 import type { ChartProps, PivotTableProps, TableProps } from '../components/charts';
-import type { ChartWidgetProps, WidgetProps } from '../components/widgets';
+import type { ChartWidgetProps } from '../components/widgets/chart-widget';
+import type { PivotTableWidgetProps } from '../components/widgets/pivot-table-widget';
+import type { TextWidgetProps, WidgetProps } from '../components/widgets/widget';
+import type { WidgetModel } from '../components/widgets/widget-model';
 /**
  * Translates a {@link WidgetModel} to the parameters for executing a query for the widget.
  *

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "2.34.0",
+  "version": "2.36.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.34.0",
-    "@sisense/sdk-ui-preact": "2.34.0",
+    "@sisense/sdk-data": "2.36.0",
+    "@sisense/sdk-ui-preact": "2.36.0",
     "lodash-es": "^4.17.21",
     "ts-deepmerge": "^8.0.0",
     "vue": "^3.3.2"