@adminforth/dashboard 1.1.0 → 1.2.0

package/services/widgetConfigValidator.ts

@@ -1,7 +1,7 @@
 import type { IAdminForth } from 'adminforth';
 import type { DashboardWidgetConfig } from '../custom/model/dashboard.types.js';
+import { normalizeChartWidgetConfig } from '../custom/widgets/chart/chart.types.js';
 import type { DashboardWidgetConfigValidationError } from '../schema/widget.js';
-import type { DashboardWidgetQueryConfig } from './widgetDataService.js';
 
 export type WidgetConfigValidatorService = {
   validateDashboardWidgetApiConfig: (
@@ -19,7 +19,9 @@ export function validateDashboardWidgetApiConfig(
 
   const errors: DashboardWidgetConfigValidationError[] = [];
 
-  if (!widget.chart) {
+  const chart = normalizeChartWidgetConfig(widget.chart);
+
+  if (!chart) {
     errors.push({
       field: 'chart',
       message: 'Chart widget must have chart config',
@@ -34,14 +36,14 @@ export function validateDashboardWidgetApiConfig(
 
     if (!resource) {
       errors.push({
-        field: 'dataSource.resourceId',
+        field: 'data_source.resource_id',
         message: `Resource "${aggregateDataSource.resourceId}" is not registered`,
       });
     }
 
     if (!aggregateDataSource.groupBy) {
       errors.push({
-        field: 'dataSource.groupBy',
+        field: 'data_source.group_by',
         message: 'Chart aggregate dataSource must define groupBy',
       });
     }
@@ -49,59 +51,10 @@ export function validateDashboardWidgetApiConfig(
     return errors;
   }
 
-  if (!widget.query) {
-    errors.push({
-      field: 'query',
-      message: 'Chart widget must have query or aggregate dataSource config',
-    });
-    return errors;
-  }
-
-  const query = widget.query as DashboardWidgetQueryConfig;
-  const chart = widget.chart;
-
-  const resource = adminforth.config.resources.find((item) => item.resourceId === query.resource);
-
-  if (!resource) {
-    errors.push({
-      field: 'query.resource',
-      message: `Resource "${query.resource}" is not registered`,
-    });
-    return errors;
-  }
-
-  if (!query.select) {
-    return errors;
-  }
-
-  const resourceFields = resource.columns.map((column) => column.name);
-
-  for (const field of query.select) {
-    if (!resourceFields.includes(field)) {
-      errors.push({
-        field: 'query.select',
-        message: `Field "${field}" is not in resource "${query.resource}"`,
-      });
-    }
-  }
-
-  const chartFields = [
-    chart.x_field,
-    chart.y_field,
-    chart.label_field,
-    chart.value_field,
-    chart.bucket_field,
-    ...(chart.series?.map((series: { field: string }) => series.field) ?? []),
-  ].filter((field): field is string => typeof field === 'string');
-
-  for (const field of chartFields) {
-    if (!query.select.includes(field)) {
-      errors.push({
-        field: 'query.select',
-        message: `Query select must include chart field "${field}"`,
-      });
-    }
-  }
+  errors.push({
+    field: 'data_source',
+    message: 'Chart widget must have aggregate dataSource config',
+  });
 
   return errors;
 }

package/services/widgetDataService.ts

@@ -13,16 +13,6 @@ import type {
   WidgetDataSource,
 } from '../custom/model/dashboard.types.js';
 
-export type DashboardWidgetQueryConfig = {
-  resource: string;
-  select?: string[];
-  order?: {
-    field: string;
-    direction: 'asc' | 'desc';
-  };
-  limit?: number;
-};
-
 export type DashboardWidgetDataOptions = {
   pagination?: {
     page: number;
@@ -44,8 +34,7 @@ export async function getWidgetData(
   widget: DashboardWidgetConfig,
   options: DashboardWidgetDataOptions = {},
 ): Promise<DashboardWidgetData | null> {
-  const legacyQuery = getLegacyQueryConfig(widget.query);
-  const dataSource = getWidgetDataSource(widget, legacyQuery);
+  const dataSource = getWidgetDataSource(widget.dataSource);
 
   if (!dataSource) {
     return null;
@@ -55,24 +44,20 @@ export async function getWidgetData(
     return getAggregateWidgetData(adminforth, dataSource);
   }
 
-  return getResourceWidgetData(adminforth, dataSource, legacyQuery, options);
+  return getResourceWidgetData(adminforth, dataSource, options);
 }
 
 async function getResourceWidgetData(
   adminforth: IAdminForth,
   dataSource: Extract<WidgetDataSource, { type: 'resource' }>,
-  legacyQuery: DashboardWidgetQueryConfig | undefined,
   options: DashboardWidgetDataOptions,
 ): Promise<DashboardWidgetData> {
   const resource = adminforth.resource(dataSource.resourceId);
   const filters = normalizeFilters(dataSource.filters);
-  const sort = normalizeSort(dataSource.sort ?? legacyQuery?.order);
+  const sort = normalizeSort(dataSource.sort);
   const pagination = options.pagination;
   const offset = pagination ? (pagination.page - 1) * pagination.pageSize : 0;
-  const queryLimit = legacyQuery?.limit;
-  const limit = pagination
-    ? Math.max(Math.min(pagination.pageSize, (queryLimit ?? Infinity) - offset), 0)
-    : queryLimit;
+  const limit = pagination ? pagination.pageSize : undefined;
 
   const rows = await resource.list(
     filters,
@@ -81,8 +66,8 @@ async function getResourceWidgetData(
     sort,
   );
 
-  const columns = dataSource.columns ?? legacyQuery?.select ?? Object.keys(rows[0] ?? {});
-  const total = pagination ? Math.min(await resource.count(filters), queryLimit ?? Infinity) : 0;
+  const columns = dataSource.columns ?? Object.keys(rows[0] ?? {});
+  const total = pagination ? await resource.count(filters) : 0;
 
   return {
     columns,
@@ -135,32 +120,12 @@ async function getAggregateWidgetData(
   };
 }
 
-function getLegacyQueryConfig(query: unknown): DashboardWidgetQueryConfig | undefined {
-  if (!isRecord(query) || typeof query.resource !== 'string') {
-    return undefined;
-  }
-
-  return query as DashboardWidgetQueryConfig;
-}
-
-function getWidgetDataSource(
-  widget: DashboardWidgetConfig,
-  legacyQuery: DashboardWidgetQueryConfig | undefined,
-): WidgetDataSource | undefined {
-  if (isWidgetDataSource(widget.dataSource)) {
-    return widget.dataSource;
+function getWidgetDataSource(dataSource: unknown): WidgetDataSource | undefined {
+  if (isWidgetDataSource(dataSource)) {
+    return dataSource;
   }
 
-  if (!legacyQuery) {
-    return undefined;
-  }
-
-  return {
-    type: 'resource',
-    resourceId: legacyQuery.resource,
-    columns: legacyQuery.select,
-    sort: legacyQuery.order,
-  };
+  return undefined;
 }
 
 function isWidgetDataSource(value: unknown): value is WidgetDataSource {