@adminforth/dashboard 1.5.0 → 1.7.0

package/custom/widgets/KpiCardWidget.vue

@@ -16,14 +16,68 @@
 
     <div
       v-else
-      class="grid gap-1"
+      class="grid gap-3"
     >
-      <div class="text-3xl font-bold text-lightNavbarText dark:text-darkNavbarText">
-        {{ formattedValue }}
-      </div>
-      <div class="text-sm text-lightListTableText dark:text-darkListTableText">
-        {{ label }}
+      <div class="grid gap-1">
+        <div class="text-3xl font-bold text-lightNavbarText dark:text-darkNavbarText">
+          {{ formattedValue }}
+        </div>
+        <div class="flex flex-wrap items-center gap-2 text-sm text-lightListTableText dark:text-darkListTableText">
+          <span>{{ label }}</span>
+          <span
+            v-if="comparison"
+            class="rounded px-1.5 py-0.5 text-xs font-medium"
+            :class="comparisonClass"
+            :title="comparison.tooltip"
+          >
+            {{ comparison.label }}
+          </span>
+        </div>
       </div>
+      <svg
+        v-if="sparklinePoints"
+        class="h-12 w-full overflow-visible"
+        viewBox="0 0 100 32"
+        preserveAspectRatio="none"
+        aria-hidden="true"
+      >
+        <defs v-if="usesSparklineGradient">
+          <linearGradient
+            :id="sparklineGradientId"
+            x1="0"
+            y1="0"
+            x2="0"
+            y2="1"
+          >
+            <stop
+              offset="0%"
+              stop-color="currentColor"
+              stop-opacity="0.24"
+            />
+            <stop
+              offset="100%"
+              stop-color="currentColor"
+              stop-opacity="0"
+            />
+          </linearGradient>
+        </defs>
+        <polygon
+          v-if="usesSparklineGradient"
+          class="text-lightPrimary dark:text-darkPrimary"
+          :points="sparklineFillPoints"
+          :fill="`url(#${sparklineGradientId})`"
+        />
+        <polyline
+          class="text-lightPrimary dark:text-darkPrimary"
+          :points="sparklinePoints"
+          fill="none"
+          stroke="currentColor"
+          stroke-width="2"
+          stroke-linecap="round"
+          stroke-linejoin="round"
+          vector-effect="non-scaling-stroke"
+        />
+      </svg>
     </div>
   </div>
 </template>
@@ -61,11 +115,120 @@ watch(
 const kpiConfig = computed(() => props.widget.target === 'kpi_card' ? props.widget.card : undefined)
 const widgetData = computed(() => data.value?.data as DashboardWidgetTableData | null)
 const columns = computed(() => widgetData.value?.columns ?? [])
-const firstRow = computed(() => widgetData.value?.rows[0] ?? {})
+const firstRow = computed(() => widgetData.value?.values ?? widgetData.value?.rows[0] ?? {})
 const valueField = computed(() => kpiConfig.value?.value.field || columns.value[0])
 const value = computed(() => toFiniteNumber(firstRow.value[valueField.value]))
 const label = computed(() => kpiConfig.value?.subtitle?.field
-  ? String(firstRow.value[kpiConfig.value.subtitle.field])
+  ? [kpiConfig.value.subtitle.text, formatValue(firstRow.value[kpiConfig.value.subtitle.field], kpiConfig.value.value.format)]
+      .filter(Boolean)
+      .join(': ')
   : kpiConfig.value?.subtitle?.text ?? kpiConfig.value?.title ?? props.widget.label)
-const formattedValue = computed(() => `${kpiConfig.value?.value.prefix ?? ''}${formatChartValue(value.value)}${kpiConfig.value?.value.suffix ?? ''}`)
+const formattedValue = computed(() => `${kpiConfig.value?.value.prefix ?? ''}${formatValue(value.value, kpiConfig.value?.value.format)}${kpiConfig.value?.value.suffix ?? ''}`)
+const comparisonValue = computed(() => toFiniteNumber(kpiConfig.value?.comparison?.field
+  ? firstRow.value[kpiConfig.value.comparison.field]
+  : undefined))
+const comparison = computed(() => {
+  const config = kpiConfig.value?.comparison
+
+  if (!config) {
+    return null
+  }
+
+  const template = config.compact?.template ?? '{sign}{value}'
+  const tooltipTemplate = config.tooltip?.template
+  const valueText = formatValue(Math.abs(comparisonValue.value), config.format, { signed: false, compactTemplate: true })
+  const sign = comparisonValue.value > 0 ? '+' : comparisonValue.value < 0 ? '-' : ''
+
+  return {
+    value: comparisonValue.value,
+    label: config.compact?.show === false ? valueText : applyTemplate(template, sign, valueText),
+    tooltip: tooltipTemplate
+      ? applyTemplate(tooltipTemplate, sign, valueText)
+      : config.tooltip?.label,
+    positiveIsGood: config.positive_is_good ?? true,
+  }
+})
+const comparisonClass = computed(() => {
+  if (!comparison.value || comparison.value.value === 0) {
+    return 'bg-lightListBorder text-lightListTableText dark:bg-darkListBorder dark:text-darkListTableText'
+  }
+
+  const isGood = comparison.value.positiveIsGood
+    ? comparison.value.value > 0
+    : comparison.value.value < 0
+
+  return isGood
+    ? 'bg-green-100 text-green-700 dark:bg-green-900/30 dark:text-green-300'
+    : 'bg-red-100 text-red-700 dark:bg-red-900/30 dark:text-red-300'
+})
+const sparklineRows = computed(() => widgetData.value?.rows ?? [])
+const sparklineConfig = computed(() => kpiConfig.value?.sparkline)
+const sparklineGradientId = computed(() => `kpi-sparkline-${props.widget.id}`)
+const usesSparklineGradient = computed(() => sparklineConfig.value?.fill?.type === 'gradient')
+const sparklineCoordinates = computed(() => {
+  const field = sparklineConfig.value?.field
+
+  if (!field || sparklineRows.value.length < 2) {
+    return []
+  }
+
+  const values = sparklineRows.value.map((row) => toFiniteNumber(row[field]))
+  const min = Math.min(...values)
+  const max = Math.max(...values)
+  const range = max - min || 1
+
+  return values.map((item, index) => ({
+    x: (index / Math.max(values.length - 1, 1)) * 100,
+    y: 30 - ((item - min) / range) * 28,
+  }))
+})
+const sparklinePoints = computed(() => sparklineCoordinates.value.length
+  ? sparklineCoordinates.value.map((point) => `${point.x},${point.y}`).join(' ')
+  : '')
+const sparklineFillPoints = computed(() => sparklineCoordinates.value.length
+  ? `0,32 ${sparklinePoints.value} 100,32`
+  : '')
+
+function applyTemplate(template: string, sign: string, value: string) {
+  return template
+    .replaceAll('{sign}', sign)
+    .replaceAll('{value}', value)
+}
+
+function formatValue(
+  rawValue: unknown,
+  format = 'number',
+  options: { signed?: boolean, compactTemplate?: boolean } = {},
+) {
+  const numericValue = toFiniteNumber(rawValue)
+  const sign = options.signed && numericValue > 0 ? '+' : ''
+  const absoluteValue = options.signed ? Math.abs(numericValue) : numericValue
+
+  if (format === 'integer') {
+    return `${sign}${formatChartValue(absoluteValue, { maximumFractionDigits: 0 })}`
+  }
+
+  if (format === 'compact_number') {
+    return `${sign}${formatChartValue(absoluteValue, { notation: 'compact', maximumFractionDigits: 1 })}`
+  }
+
+  if (format === 'currency' || format === 'currency_delta') {
+    return `${sign}${formatChartValue(absoluteValue, {
+      style: 'currency',
+      currency: 'USD',
+      maximumFractionDigits: 2,
+    })}`
+  }
+
+  if (format === 'percent' || format === 'percent_delta') {
+    const value = formatChartValue(absoluteValue, { maximumFractionDigits: 1 })
+    return options.compactTemplate ? value : `${sign}${value}%`
+  }
+
+  if (format === 'number_delta') {
+    return `${sign}${formatChartValue(absoluteValue, { maximumFractionDigits: 2 })}`
+  }
+
+  return `${sign}${formatChartValue(absoluteValue, { maximumFractionDigits: 2 })}`
+}
 </script>

package/custom/widgets/chart/ChartWidget.vue

@@ -83,11 +83,11 @@
 import { computed, watch } from 'vue'
 import { useWidgetData } from '../../queries/useWidgetData.js'
 import type { ChartDashboardWidgetConfig, DashboardWidgetTableData } from '../../model/dashboard.types.js'
-import BarChart from './bar/BarChart.vue'
-import FunnelChart from './funnel/FunnelChart.vue'
-import LineChart from './line/LineChart.vue'
-import PieChart from './pie/PieChart.vue'
-import StackedBarChart from './stacked-bar/StackedBarChart.vue'
+import BarChart from './BarChart.vue'
+import FunnelChart from './FunnelChart.vue'
+import LineChart from './LineChart.vue'
+import PieChart from './PieChart.vue'
+import StackedBarChart from './StackedBarChart.vue'
 import { toFiniteNumber } from './chart.utils.js'
 
 const DEFAULT_WIDGET_HEIGHT = 500

package/custom/widgets/registry.ts

@@ -1,10 +1,10 @@
 import type { Component } from 'vue'
 import type { DashboardWidgetTarget } from '../model/dashboard.types.js'
 import ChartWidget from './chart/ChartWidget.vue'
-import GaugeCardWidget from './gauge-card/GaugeCardWidget.vue'
-import KpiCardWidget from './kpi-card/KpiCardWidget.vue'
-import PivotTableWidget from './pivot-table/PivotTableWidget.vue'
-import TableWidget from './table/TableWidget.vue'
+import GaugeCardWidget from './GaugeCardWidget.vue'
+import KpiCardWidget from './KpiCardWidget.vue'
+import PivotTableWidget from './PivotTableWidget.vue'
+import TableWidget from './TableWidget.vue'
 
 export type DashboardWidgetType = DashboardWidgetTarget
 

package/dist/custom/api/dashboardApi.d.ts

@@ -1,4 +1,4 @@
-import type { DashboardConfig, EditableDashboardGroupConfig, DashboardGroupMoveDirection, DashboardWidgetConfig, DashboardWidgetConfigValidationError, DashboardWidgetMoveDirection } from '../model/dashboard.types.js';
+import type { DashboardConfig, EditableDashboardGroupConfig, DashboardGroupMoveDirection, ChartDashboardWidgetConfig, DashboardWidgetConfig, DashboardWidgetConfigValidationError, DashboardWidgetMoveDirection, GaugeCardWidgetConfig, KpiCardWidgetConfig, PivotTableWidgetConfig, TableWidgetConfig } from '../model/dashboard.types.js';
 export type DashboardResponse = {
     id: string;
     slug: string;
@@ -16,6 +16,41 @@ export type DashboardWidgetDataRequest = {
         pageSize: number;
     };
 };
+export type ConfigurableTableWidgetConfig = Omit<TableWidgetConfig, 'id' | 'group_id' | 'order'>;
+export type ConfigurableKpiCardWidgetConfig = Omit<KpiCardWidgetConfig, 'id' | 'group_id' | 'order'>;
+export type ConfigurableGaugeCardWidgetConfig = Omit<GaugeCardWidgetConfig, 'id' | 'group_id' | 'order'>;
+export type ConfigurableChartWidgetConfig = Omit<ChartDashboardWidgetConfig, 'id' | 'group_id' | 'order'>;
+export type ConfigurableLineChartWidgetConfig = ConfigurableChartWidgetConfig & {
+    chart: {
+        type: 'line';
+    };
+};
+export type ConfigurableBarChartWidgetConfig = ConfigurableChartWidgetConfig & {
+    chart: {
+        type: 'bar';
+    };
+};
+export type ConfigurableStackedBarChartWidgetConfig = ConfigurableChartWidgetConfig & {
+    chart: {
+        type: 'stacked_bar';
+    };
+};
+export type ConfigurablePieChartWidgetConfig = ConfigurableChartWidgetConfig & {
+    chart: {
+        type: 'pie';
+    };
+};
+export type ConfigurableHistogramChartWidgetConfig = ConfigurableChartWidgetConfig & {
+    chart: {
+        type: 'histogram';
+    };
+};
+export type ConfigurableFunnelChartWidgetConfig = ConfigurableChartWidgetConfig & {
+    chart: {
+        type: 'funnel';
+    };
+};
+export type ConfigurablePivotTableWidgetConfig = Omit<PivotTableWidgetConfig, 'id' | 'group_id' | 'order'>;
 export declare class DashboardApiError extends Error {
     validationErrors: DashboardWidgetConfigValidationError[];
     constructor(message: string, validationErrors?: DashboardWidgetConfigValidationError[]);
@@ -30,5 +65,15 @@ export declare const dashboardApi: {
     moveDashboardWidget(slug: string, widgetId: string, direction: DashboardWidgetMoveDirection): Promise<DashboardResponse>;
     removeDashboardWidget(slug: string, widgetId: string): Promise<DashboardResponse>;
     setWidgetConfig(slug: string, widgetId: string, config: unknown): Promise<DashboardResponse>;
+    configureTableWidget(slug: string, widgetId: string, config: ConfigurableTableWidgetConfig): Promise<DashboardResponse>;
+    configureKpiCardWidget(slug: string, widgetId: string, config: ConfigurableKpiCardWidgetConfig): Promise<DashboardResponse>;
+    configureGaugeCardWidget(slug: string, widgetId: string, config: ConfigurableGaugeCardWidgetConfig): Promise<DashboardResponse>;
+    configureLineChartWidget(slug: string, widgetId: string, config: ConfigurableLineChartWidgetConfig): Promise<DashboardResponse>;
+    configureBarChartWidget(slug: string, widgetId: string, config: ConfigurableBarChartWidgetConfig): Promise<DashboardResponse>;
+    configureStackedBarChartWidget(slug: string, widgetId: string, config: ConfigurableStackedBarChartWidgetConfig): Promise<DashboardResponse>;
+    configurePieChartWidget(slug: string, widgetId: string, config: ConfigurablePieChartWidgetConfig): Promise<DashboardResponse>;
+    configureHistogramChartWidget(slug: string, widgetId: string, config: ConfigurableHistogramChartWidgetConfig): Promise<DashboardResponse>;
+    configureFunnelChartWidget(slug: string, widgetId: string, config: ConfigurableFunnelChartWidgetConfig): Promise<DashboardResponse>;
+    configurePivotTableWidget(slug: string, widgetId: string, config: ConfigurablePivotTableWidgetConfig): Promise<DashboardResponse>;
     getDashboardWidgetData(slug: string, widgetId: string, request?: DashboardWidgetDataRequest): Promise<DashboardWidgetDataResponse>;
 };

package/dist/custom/api/dashboardApi.js

@@ -164,6 +164,96 @@ export const dashboardApi = {
             });
         });
     },
+    configureTableWidget(slug, widgetId, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return callDashboardApi('/adminapi/v1/dashboard/configure_table_widget', {
+                slug,
+                widgetId,
+                config,
+            });
+        });
+    },
+    configureKpiCardWidget(slug, widgetId, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return callDashboardApi('/adminapi/v1/dashboard/configure_kpi_card_widget', {
+                slug,
+                widgetId,
+                config,
+            });
+        });
+    },
+    configureGaugeCardWidget(slug, widgetId, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return callDashboardApi('/adminapi/v1/dashboard/configure_gauge_card_widget', {
+                slug,
+                widgetId,
+                config,
+            });
+        });
+    },
+    configureLineChartWidget(slug, widgetId, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return callDashboardApi('/adminapi/v1/dashboard/configure_line_chart_widget', {
+                slug,
+                widgetId,
+                config,
+            });
+        });
+    },
+    configureBarChartWidget(slug, widgetId, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return callDashboardApi('/adminapi/v1/dashboard/configure_bar_chart_widget', {
+                slug,
+                widgetId,
+                config,
+            });
+        });
+    },
+    configureStackedBarChartWidget(slug, widgetId, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return callDashboardApi('/adminapi/v1/dashboard/configure_stacked_bar_chart_widget', {
+                slug,
+                widgetId,
+                config,
+            });
+        });
+    },
+    configurePieChartWidget(slug, widgetId, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return callDashboardApi('/adminapi/v1/dashboard/configure_pie_chart_widget', {
+                slug,
+                widgetId,
+                config,
+            });
+        });
+    },
+    configureHistogramChartWidget(slug, widgetId, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return callDashboardApi('/adminapi/v1/dashboard/configure_histogram_chart_widget', {
+                slug,
+                widgetId,
+                config,
+            });
+        });
+    },
+    configureFunnelChartWidget(slug, widgetId, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return callDashboardApi('/adminapi/v1/dashboard/configure_funnel_chart_widget', {
+                slug,
+                widgetId,
+                config,
+            });
+        });
+    },
+    configurePivotTableWidget(slug, widgetId, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return callDashboardApi('/adminapi/v1/dashboard/configure_pivot_table_widget', {
+                slug,
+                widgetId,
+                config,
+            });
+        });
+    },
     getDashboardWidgetData(slug_1, widgetId_1) {
         return __awaiter(this, arguments, void 0, function* (slug, widgetId, request = {}) {
             return callDashboardWidgetDataApi('/adminapi/v1/dashboard/get_dashboard_widget_data', Object.assign({ slug,

package/dist/custom/api/dashboardApi.ts

@@ -1,11 +1,15 @@
 import type {
   DashboardConfig,
   EditableDashboardGroupConfig,
-  EditableDashboardWidgetConfig,
   DashboardGroupMoveDirection,
+  ChartDashboardWidgetConfig,
   DashboardWidgetConfig,
   DashboardWidgetConfigValidationError,
   DashboardWidgetMoveDirection,
+  GaugeCardWidgetConfig,
+  KpiCardWidgetConfig,
+  PivotTableWidgetConfig,
+  TableWidgetConfig,
 } from '../model/dashboard.types.js'
 
 export type DashboardResponse = {
@@ -28,6 +32,18 @@ export type DashboardWidgetDataRequest = {
   }
 }
 
+export type ConfigurableTableWidgetConfig = Omit<TableWidgetConfig, 'id' | 'group_id' | 'order'>
+export type ConfigurableKpiCardWidgetConfig = Omit<KpiCardWidgetConfig, 'id' | 'group_id' | 'order'>
+export type ConfigurableGaugeCardWidgetConfig = Omit<GaugeCardWidgetConfig, 'id' | 'group_id' | 'order'>
+export type ConfigurableChartWidgetConfig = Omit<ChartDashboardWidgetConfig, 'id' | 'group_id' | 'order'>
+export type ConfigurableLineChartWidgetConfig = ConfigurableChartWidgetConfig & { chart: { type: 'line' } }
+export type ConfigurableBarChartWidgetConfig = ConfigurableChartWidgetConfig & { chart: { type: 'bar' } }
+export type ConfigurableStackedBarChartWidgetConfig = ConfigurableChartWidgetConfig & { chart: { type: 'stacked_bar' } }
+export type ConfigurablePieChartWidgetConfig = ConfigurableChartWidgetConfig & { chart: { type: 'pie' } }
+export type ConfigurableHistogramChartWidgetConfig = ConfigurableChartWidgetConfig & { chart: { type: 'histogram' } }
+export type ConfigurableFunnelChartWidgetConfig = ConfigurableChartWidgetConfig & { chart: { type: 'funnel' } }
+export type ConfigurablePivotTableWidgetConfig = Omit<PivotTableWidgetConfig, 'id' | 'group_id' | 'order'>
+
 export class DashboardApiError extends Error {
   validationErrors: DashboardWidgetConfigValidationError[]
 
@@ -205,6 +221,126 @@ export const dashboardApi = {
     })
   },
 
+  async configureTableWidget(
+    slug: string,
+    widgetId: string,
+    config: ConfigurableTableWidgetConfig,
+  ): Promise<DashboardResponse> {
+    return callDashboardApi('/adminapi/v1/dashboard/configure_table_widget', {
+      slug,
+      widgetId,
+      config,
+    })
+  },
+
+  async configureKpiCardWidget(
+    slug: string,
+    widgetId: string,
+    config: ConfigurableKpiCardWidgetConfig,
+  ): Promise<DashboardResponse> {
+    return callDashboardApi('/adminapi/v1/dashboard/configure_kpi_card_widget', {
+      slug,
+      widgetId,
+      config,
+    })
+  },
+
+  async configureGaugeCardWidget(
+    slug: string,
+    widgetId: string,
+    config: ConfigurableGaugeCardWidgetConfig,
+  ): Promise<DashboardResponse> {
+    return callDashboardApi('/adminapi/v1/dashboard/configure_gauge_card_widget', {
+      slug,
+      widgetId,
+      config,
+    })
+  },
+
+  async configureLineChartWidget(
+    slug: string,
+    widgetId: string,
+    config: ConfigurableLineChartWidgetConfig,
+  ): Promise<DashboardResponse> {
+    return callDashboardApi('/adminapi/v1/dashboard/configure_line_chart_widget', {
+      slug,
+      widgetId,
+      config,
+    })
+  },
+
+  async configureBarChartWidget(
+    slug: string,
+    widgetId: string,
+    config: ConfigurableBarChartWidgetConfig,
+  ): Promise<DashboardResponse> {
+    return callDashboardApi('/adminapi/v1/dashboard/configure_bar_chart_widget', {
+      slug,
+      widgetId,
+      config,
+    })
+  },
+
+  async configureStackedBarChartWidget(
+    slug: string,
+    widgetId: string,
+    config: ConfigurableStackedBarChartWidgetConfig,
+  ): Promise<DashboardResponse> {
+    return callDashboardApi('/adminapi/v1/dashboard/configure_stacked_bar_chart_widget', {
+      slug,
+      widgetId,
+      config,
+    })
+  },
+
+  async configurePieChartWidget(
+    slug: string,
+    widgetId: string,
+    config: ConfigurablePieChartWidgetConfig,
+  ): Promise<DashboardResponse> {
+    return callDashboardApi('/adminapi/v1/dashboard/configure_pie_chart_widget', {
+      slug,
+      widgetId,
+      config,
+    })
+  },
+
+  async configureHistogramChartWidget(
+    slug: string,
+    widgetId: string,
+    config: ConfigurableHistogramChartWidgetConfig,
+  ): Promise<DashboardResponse> {
+    return callDashboardApi('/adminapi/v1/dashboard/configure_histogram_chart_widget', {
+      slug,
+      widgetId,
+      config,
+    })
+  },
+
+  async configureFunnelChartWidget(
+    slug: string,
+    widgetId: string,
+    config: ConfigurableFunnelChartWidgetConfig,
+  ): Promise<DashboardResponse> {
+    return callDashboardApi('/adminapi/v1/dashboard/configure_funnel_chart_widget', {
+      slug,
+      widgetId,
+      config,
+    })
+  },
+
+  async configurePivotTableWidget(
+    slug: string,
+    widgetId: string,
+    config: ConfigurablePivotTableWidgetConfig,
+  ): Promise<DashboardResponse> {
+    return callDashboardApi('/adminapi/v1/dashboard/configure_pivot_table_widget', {
+      slug,
+      widgetId,
+      config,
+    })
+  },
+
   async getDashboardWidgetData(
     slug: string,
     widgetId: string,

package/dist/custom/model/dashboard.types.d.ts

@@ -24,7 +24,7 @@ export type DashboardWidgetConfigValidationError = {
 };
 export type QueryAggregateOperation = 'sum' | 'count' | 'count_distinct' | 'avg' | 'min' | 'max' | 'median';
 export type TimeGrain = 'day' | 'week' | 'month' | 'year';
-export type ValueFormat = 'number' | 'compact_number' | 'currency' | 'percent' | 'percent_delta' | 'number_delta' | 'currency_delta';
+export type ValueFormat = 'number' | 'integer' | 'compact_number' | 'currency' | 'percent' | 'percent_delta' | 'number_delta' | 'currency_delta';
 export type WidgetLayout = {
     size?: DashboardWidgetSize;
     width?: number;
@@ -90,21 +90,17 @@ export type QueryOrderByItem = {
 export type QueryConfig = {
     resource: string;
     select?: QuerySelectItem[];
+    sparkline?: {
+        field: string;
+        grain: TimeGrain;
+        as: string;
+        fill_missing?: Record<string, JsonValue>;
+    };
     filters?: FilterExpression;
     group_by?: QueryGroupByItem[];
     order_by?: QueryOrderByItem[];
     limit?: number;
     offset?: number;
-    time_series?: {
-        field: string;
-        grain: TimeGrain;
-        timezone?: string;
-    };
-    period?: {
-        field: string;
-        gte?: JsonValue;
-        lt?: JsonValue;
-    };
     bucket?: {
         field: string;
         buckets: Array<{
@@ -148,8 +144,29 @@ export type KpiCardViewConfig = {
         text?: string;
         field?: string;
     };
-    comparison?: JsonValue;
-    sparkline?: JsonValue;
+    comparison?: {
+        field: string;
+        format?: ValueFormat;
+        positive_is_good?: boolean;
+        compact?: {
+            show?: boolean;
+            template?: string;
+        };
+        tooltip?: {
+            label?: string;
+            template?: string;
+        };
+    };
+    sparkline?: {
+        type?: 'line';
+        field: string;
+        x: string;
+        show_axes?: boolean;
+        show_labels?: boolean;
+        fill?: {
+            type?: 'gradient' | 'solid';
+        };
+    };
 };
 export type GaugeCardViewConfig = {
     title?: string;
@@ -211,7 +228,6 @@ export type PivotTableWidgetConfig = WidgetBaseConfig & {
     query: QueryConfig;
 };
 export type DashboardWidgetConfig = EmptyWidgetConfig | TableWidgetConfig | ChartDashboardWidgetConfig | KpiCardWidgetConfig | GaugeCardWidgetConfig | PivotTableWidgetConfig;
-export type EditableDashboardWidgetConfig = Omit<EmptyWidgetConfig, 'id' | 'group_id' | 'order'> | Omit<TableWidgetConfig, 'id' | 'group_id' | 'order'> | Omit<ChartDashboardWidgetConfig, 'id' | 'group_id' | 'order'> | Omit<KpiCardWidgetConfig, 'id' | 'group_id' | 'order'> | Omit<GaugeCardWidgetConfig, 'id' | 'group_id' | 'order'> | Omit<PivotTableWidgetConfig, 'id' | 'group_id' | 'order'>;
 export type DashboardWidgetTableData = {
     kind?: 'table';
     columns: string[];

package/dist/custom/model/dashboard.types.js

@@ -10,8 +10,8 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 export function serializeDashboardWidgetConfigForEditor(widget) {
-    const { id: _id, group_id: _groupId, order: _order } = widget, editableWidget = __rest(widget, ["id", "group_id", "order"]);
-    return editableWidget;
+    const { id: _id, group_id: _groupId, order: _order } = widget, editableWidgetConfig = __rest(widget, ["id", "group_id", "order"]);
+    return editableWidgetConfig;
 }
 export function getFieldRefField(value) {
     return typeof value === 'string' ? value : value === null || value === void 0 ? void 0 : value.field;