@adminforth/dashboard 1.4.2 → 1.6.0

package/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[]
 
@@ -140,10 +156,6 @@ export const dashboardApi = {
     return callDashboardApi('/adminapi/v1/dashboard/get-config', { slug })
   },
 
-  async setDashboardConfig(slug: string, config: unknown): Promise<DashboardResponse> {
-    return callDashboardApi('/adminapi/v1/dashboard/set_dashboard_config', { slug, config })
-  },
-
   async addDashboardGroup(slug: string): Promise<DashboardResponse> {
     return callDashboardApi('/adminapi/v1/dashboard/add_dashboard_group', { slug })
   },
@@ -209,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/custom/model/dashboard.types.ts

@@ -36,6 +36,7 @@ export type QueryAggregateOperation = 'sum' | 'count' | 'count_distinct' | 'avg'
 export type TimeGrain = 'day' | 'week' | 'month' | 'year'
 export type ValueFormat =
   | 'number'
+  | 'integer'
   | 'compact_number'
   | 'currency'
   | 'percent'
@@ -119,21 +120,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<{ label: string, min?: number, max?: number }>
@@ -178,8 +175,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 = {
@@ -257,14 +275,6 @@ export type DashboardWidgetConfig =
   | 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[]
@@ -299,10 +309,10 @@ export function serializeDashboardWidgetConfigForEditor(
     id: _id,
     group_id: _groupId,
     order: _order,
-    ...editableWidget
+    ...editableWidgetConfig
   } = widget
 
-  return editableWidget
+  return editableWidgetConfig
 }
 
 export function getFieldRefField(value: FieldRef | undefined) {

package/custom/runtime/DashboardRuntime.vue

@@ -208,7 +208,6 @@ import type {
   DashboardConfig,
   DashboardGroupConfig,
   EditableDashboardGroupConfig,
-  EditableDashboardWidgetConfig,
   DashboardGroupMoveDirection,
   DashboardWidgetConfig,
   DashboardWidgetMoveDirection,
@@ -414,13 +413,13 @@ async function saveWidgetConfig() {
   try {
     widgetConfigError.value = ''
     widgetConfigFieldErrors.value = []
-    const widgetConfig = parseYaml(widgetConfigCode.value) as EditableDashboardWidgetConfig
+    const widgetConfig = parseYaml(widgetConfigCode.value) as DashboardWidgetConfig
 
     applyDashboardResponse(
       await dashboardApi.setWidgetConfig(
         props.dashboardSlug,
         editingWidgetId.value,
-        widgetConfig,
+        serializeDashboardWidgetConfigForEditor(widgetConfig),
       ),
     )
     closeWidgetConfigEditor()