@adminforth/dashboard 1.5.0 → 1.6.0

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;

package/dist/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) {