@adminforth/dashboard 1.3.0 → 1.4.1

package/endpoint/groups.ts

@@ -2,6 +2,7 @@ import type { AdminUser, IHttpServer } from 'adminforth';
 import { randomUUID } from 'crypto';
 import type {
   DashboardConfig,
+  EditableDashboardGroupConfig,
   DashboardGroupConfig,
 } from '../custom/model/dashboard.types.js';
 import {
@@ -11,14 +12,7 @@ import {
   SetGroupConfigRequestSchema,
   SlugRequestSchema,
 } from '../schema/api.js';
-
-type DashboardRecord = {
-  id: string;
-  slug: string;
-  label: string;
-  revision: number;
-  config: unknown;
-};
+import type { DashboardRecord, PersistedDashboardResponse } from '../services/dashboardConfigService.js';
 
 type GroupEndpointsContext = {
   canEditDashboard: (adminUser: AdminUser) => boolean;
@@ -27,20 +21,7 @@ type GroupEndpointsContext = {
   persistDashboardConfig: (
     dashboard: DashboardRecord,
     config: DashboardConfig,
-  ) => Promise<{
-    id: string;
-    slug: string;
-    label: string;
-    revision: number;
-    config: DashboardConfig;
-  }>;
-  buildDashboardResponse: (dashboard: DashboardRecord) => {
-    id: string;
-    slug: string;
-    label: string;
-    revision: number;
-    config: DashboardConfig;
-  };
+  ) => Promise<PersistedDashboardResponse>;
 };
 
 export function registerGroupEndpoints(
@@ -59,8 +40,7 @@ export function registerGroupEndpoints(
         return { error: 'Dashboard edit is not allowed' };
       }
 
-      const slug = String(body?.slug || 'default');
-      const dashboard = await ctx.getDashboardRecord(slug);
+      const dashboard = await ctx.getDashboardRecord(body.slug);
 
       if (!dashboard) {
         response.setStatus(404);
@@ -95,9 +75,8 @@ export function registerGroupEndpoints(
         return { error: 'Dashboard edit is not allowed' };
       }
 
-      const slug = String(body?.slug || 'default');
-      const groupId = String(body?.groupId || '');
-      const dashboard = await ctx.getDashboardRecord(slug);
+      const groupId = body.groupId;
+      const dashboard = await ctx.getDashboardRecord(body.slug);
 
       if (!dashboard) {
         response.setStatus(404);
@@ -112,14 +91,16 @@ export function registerGroupEndpoints(
         return { error: 'Dashboard group not found' };
       }
 
+      const nextGroup: DashboardGroupConfig = {
+        ...(body.config as EditableDashboardGroupConfig),
+        id: group.id,
+        order: group.order,
+      };
+
       return ctx.persistDashboardConfig(dashboard, {
         ...config,
         groups: config.groups.map((item) => item.id === groupId
-          ? {
-              ...(body.config as DashboardGroupConfig),
-              id: group.id,
-              order: group.order,
-            }
+          ? nextGroup
           : item),
       });
     },
@@ -137,10 +118,7 @@ export function registerGroupEndpoints(
         return { error: 'Dashboard edit is not allowed' };
       }
 
-      const slug = String(body?.slug || 'default');
-      const groupId = String(body?.groupId || '');
-      const direction = body?.direction === 'down' ? 'down' : 'up';
-      const dashboard = await ctx.getDashboardRecord(slug);
+      const dashboard = await ctx.getDashboardRecord(body.slug);
 
       if (!dashboard) {
         response.setStatus(404);
@@ -149,17 +127,23 @@ export function registerGroupEndpoints(
 
       const config = ctx.parseStoredDashboardConfig(dashboard.config);
       const sortedGroups = [...config.groups].sort((a, b) => a.order - b.order);
-      const currentIndex = sortedGroups.findIndex((group) => group.id === groupId);
+      const currentIndex = sortedGroups.findIndex((group) => group.id === body.groupId);
 
       if (currentIndex === -1) {
         response.setStatus(404);
         return { error: 'Dashboard group not found' };
       }
 
-      const targetIndex = direction === 'up' ? currentIndex - 1 : currentIndex + 1;
+      const targetIndex = body.direction === 'up' ? currentIndex - 1 : currentIndex + 1;
 
       if (targetIndex < 0 || targetIndex >= sortedGroups.length) {
-        return ctx.buildDashboardResponse(dashboard);
+        return {
+          id: dashboard.id,
+          slug: dashboard.slug,
+          label: dashboard.label,
+          revision: dashboard.revision,
+          config: ctx.parseStoredDashboardConfig(dashboard.config),
+        };
       }
 
       const reorderedGroups = [...sortedGroups];
@@ -185,9 +169,8 @@ export function registerGroupEndpoints(
         return { error: 'Dashboard edit is not allowed' };
       }
 
-      const slug = String(body?.slug || 'default');
-      const groupId = String(body?.groupId || '');
-      const dashboard = await ctx.getDashboardRecord(slug);
+      const groupId = body.groupId;
+      const dashboard = await ctx.getDashboardRecord(body.slug);
 
       if (!dashboard) {
         response.setStatus(404);

package/endpoint/widgets.ts

@@ -1,9 +1,11 @@
 import type { AdminUser, IHttpServer } from 'adminforth';
 import { randomUUID } from 'crypto';
-import {
-  normalizeDashboardWidgetConfig,
+import type {
+  DashboardConfig,
+  DashboardVariables,
+  DashboardWidgetConfig,
+  EditableDashboardWidgetConfig,
 } from '../custom/model/dashboard.types.js';
-import type { DashboardConfig, DashboardWidgetConfig } from '../custom/model/dashboard.types.js';
 import {
   DashboardApiResponseSchema,
   DashboardWidgetDataResponseSchema,
@@ -13,8 +15,6 @@ import {
   WidgetDataRequestSchema,
   WidgetIdRequestSchema,
 } from '../schema/api.js';
-import { StoredWidgetConfigSchema } from '../schema/widget.js';
-import type { DashboardWidgetConfigValidationError } from '../schema/widget.js';
 import type { DashboardRecord, PersistedDashboardResponse } from '../services/dashboardConfigService.js';
 
 type WidgetEndpointsContext = {
@@ -25,49 +25,15 @@ type WidgetEndpointsContext = {
     dashboard: DashboardRecord,
     config: DashboardConfig,
   ) => Promise<PersistedDashboardResponse>;
-  buildDashboardResponse: (dashboard: DashboardRecord) => PersistedDashboardResponse;
-  validateDashboardWidgetApiConfig: (
-    widget: DashboardWidgetConfig,
-  ) => DashboardWidgetConfigValidationError[];
   getWidgetData: (
     widget: DashboardWidgetConfig,
-    options?: { pagination?: { page: number, pageSize: number } },
+    options?: {
+      pagination?: { page: number, pageSize: number },
+      variables?: DashboardVariables,
+    },
   ) => Promise<unknown>;
 };
 
-function formatWidgetConfigValidationErrors(error: { issues: { path: PropertyKey[], message: string }[] }) {
-  return error.issues.map((issue) => ({
-    field: issue.path.length ? formatWidgetConfigFieldPath(issue.path.map(String).join('.')) : 'config',
-    message: issue.message,
-  }));
-}
-
-function formatWidgetConfigApiValidationErrors(errors: DashboardWidgetConfigValidationError[]) {
-  return errors.map((error) => ({
-    ...error,
-    field: formatWidgetConfigFieldPath(error.field),
-  }));
-}
-
-function formatWidgetConfigFieldPath(field: string) {
-  const fieldAliases = new Map([
-    ['minWidth', 'min_width'],
-    ['maxWidth', 'max_width'],
-    ['groupBy', 'group_by'],
-    ['orderBy', 'order_by'],
-    ['pageSize', 'page_size'],
-    ['timeSeries', 'time_series'],
-    ['valueField', 'value_field'],
-    ['targetValue', 'target_value'],
-    ['targetField', 'target_field'],
-  ]);
-
-  return field
-    .split('.')
-    .map((segment) => fieldAliases.get(segment) ?? segment)
-    .join('.');
-}
-
 export function registerWidgetEndpoints(
   server: IHttpServer,
   ctx: WidgetEndpointsContext,
@@ -84,9 +50,7 @@ export function registerWidgetEndpoints(
         return { error: 'Dashboard edit is not allowed' };
       }
 
-      const slug = String(body?.slug || 'default');
-      const groupId = String(body?.groupId || '');
-      const dashboard = await ctx.getDashboardRecord(slug);
+      const dashboard = await ctx.getDashboardRecord(body.slug);
 
       if (!dashboard) {
         response.setStatus(404);
@@ -94,17 +58,17 @@ export function registerWidgetEndpoints(
       }
 
       const config = ctx.parseStoredDashboardConfig(dashboard.config);
-      const group = config.groups.find((item) => item.id === groupId);
+      const group = config.groups.find((item) => item.id === body.groupId);
 
       if (!group) {
         response.setStatus(404);
         return { error: 'Dashboard group not found' };
       }
 
-      const nextOrder = config.widgets.filter((item) => item.group_id === groupId).length + 1;
+      const nextOrder = config.widgets.filter((item) => item.group_id === body.groupId).length + 1;
       const widget: DashboardWidgetConfig = {
         id: `widget_${randomUUID()}`,
-        group_id: groupId,
+        group_id: body.groupId,
         label: 'New widget',
         size: 'small',
         order: nextOrder,
@@ -130,10 +94,7 @@ export function registerWidgetEndpoints(
         return { error: 'Dashboard edit is not allowed' };
       }
 
-      const slug = String(body?.slug || 'default');
-      const widgetId = String(body?.widgetId || '');
-      const direction = body?.direction === 'down' ? 'down' : 'up';
-      const dashboard = await ctx.getDashboardRecord(slug);
+      const dashboard = await ctx.getDashboardRecord(body.slug);
 
       if (!dashboard) {
         response.setStatus(404);
@@ -141,7 +102,7 @@ export function registerWidgetEndpoints(
       }
 
       const config = ctx.parseStoredDashboardConfig(dashboard.config);
-      const widget = config.widgets.find((item) => item.id === widgetId);
+      const widget = config.widgets.find((item) => item.id === body.widgetId);
 
       if (!widget) {
         response.setStatus(404);
@@ -151,11 +112,17 @@ export function registerWidgetEndpoints(
       const sortedWidgets = config.widgets
         .filter((item) => item.group_id === widget.group_id)
         .sort((a, b) => a.order - b.order);
-      const currentIndex = sortedWidgets.findIndex((item) => item.id === widgetId);
-      const targetIndex = direction === 'up' ? currentIndex - 1 : currentIndex + 1;
+      const currentIndex = sortedWidgets.findIndex((item) => item.id === body.widgetId);
+      const targetIndex = body.direction === 'up' ? currentIndex - 1 : currentIndex + 1;
 
       if (targetIndex < 0 || targetIndex >= sortedWidgets.length) {
-        return ctx.buildDashboardResponse(dashboard);
+        return {
+          id: dashboard.id,
+          slug: dashboard.slug,
+          label: dashboard.label,
+          revision: dashboard.revision,
+          config: ctx.parseStoredDashboardConfig(dashboard.config),
+        };
       }
 
       const reorderedWidgets = [...sortedWidgets];
@@ -185,9 +152,7 @@ export function registerWidgetEndpoints(
         return { error: 'Dashboard edit is not allowed' };
       }
 
-      const slug = String(body?.slug || 'default');
-      const widgetId = String(body?.widgetId || '');
-      const dashboard = await ctx.getDashboardRecord(slug);
+      const dashboard = await ctx.getDashboardRecord(body.slug);
 
       if (!dashboard) {
         response.setStatus(404);
@@ -195,7 +160,7 @@ export function registerWidgetEndpoints(
       }
 
       const config = ctx.parseStoredDashboardConfig(dashboard.config);
-      const nextWidgets = config.widgets.filter((item) => item.id !== widgetId);
+      const nextWidgets = config.widgets.filter((item) => item.id !== body.widgetId);
 
       if (nextWidgets.length === config.widgets.length) {
         response.setStatus(404);
@@ -221,9 +186,7 @@ export function registerWidgetEndpoints(
         return { error: 'Dashboard edit is not allowed' };
       }
 
-      const slug = String(body?.slug || 'default');
-      const widgetId = String(body?.widgetId || '');
-      const dashboard = await ctx.getDashboardRecord(slug);
+      const dashboard = await ctx.getDashboardRecord(body.slug);
 
       if (!dashboard) {
         response.setStatus(404);
@@ -231,43 +194,26 @@ export function registerWidgetEndpoints(
       }
 
       const config = ctx.parseStoredDashboardConfig(dashboard.config);
-      const widget = config.widgets.find((item) => item.id === widgetId);
+      const widget = config.widgets.find((item) => item.id === body.widgetId);
 
       if (!widget) {
         response.setStatus(404);
         return { error: 'Dashboard widget not found' };
       }
 
-      const parsedWidgetConfig = StoredWidgetConfigSchema.safeParse(normalizeDashboardWidgetConfig(body.config));
-
-      if (!parsedWidgetConfig.success) {
-        response.setStatus(422);
-        return {
-          error: 'Invalid widget config',
-          validationErrors: formatWidgetConfigValidationErrors(parsedWidgetConfig.error),
-        };
-      }
-
-      const typedWidgetConfig = parsedWidgetConfig.data as DashboardWidgetConfig;
-      const apiValidationErrors = ctx.validateDashboardWidgetApiConfig(typedWidgetConfig);
+      const typedWidgetConfig = body.config as EditableDashboardWidgetConfig;
 
-      if (apiValidationErrors.length) {
-        response.setStatus(422);
-        return {
-          error: 'Invalid widget config',
-          validationErrors: formatWidgetConfigApiValidationErrors(apiValidationErrors),
-        };
-      }
+      const nextWidget: DashboardWidgetConfig = {
+        ...typedWidgetConfig,
+        id: widget.id,
+        group_id: widget.group_id,
+        order: widget.order,
+      };
 
       return ctx.persistDashboardConfig(dashboard, {
         ...config,
-        widgets: config.widgets.map((item) => item.id === widgetId
-          ? {
-              ...typedWidgetConfig,
-              id: widget.id,
-              group_id: widget.group_id,
-              order: widget.order,
-            }
+        widgets: config.widgets.map((item) => item.id === body.widgetId
+          ? nextWidget
           : item),
       });
     },
@@ -280,9 +226,7 @@ export function registerWidgetEndpoints(
     request_schema: WidgetDataRequestSchema,
     response_schema: DashboardWidgetDataResponseSchema,
     handler: async ({ body, response }) => {
-      const slug = String(body?.slug || 'default');
-      const widgetId = String(body?.widgetId || '');
-      const dashboard = await ctx.getDashboardRecord(slug);
+      const dashboard = await ctx.getDashboardRecord(body.slug);
 
       if (!dashboard) {
         response.setStatus(404);
@@ -290,7 +234,7 @@ export function registerWidgetEndpoints(
       }
 
       const config = ctx.parseStoredDashboardConfig(dashboard.config);
-      const widget = config.widgets.find((item) => item.id === widgetId);
+      const widget = config.widgets.find((item) => item.id === body.widgetId);
 
       if (!widget) {
         response.setStatus(404);
@@ -300,7 +244,8 @@ export function registerWidgetEndpoints(
       return {
         widget,
         data: await ctx.getWidgetData(widget, {
-          pagination: body?.pagination,
+          pagination: body.pagination,
+          variables: widget.variables,
         }),
       };
     },

package/index.ts

@@ -8,7 +8,6 @@ import { registerGroupEndpoints } from "./endpoint/groups.js";
 import { registerWidgetEndpoints } from './endpoint/widgets.js';
 import { createDashboardConfigService } from "./services/dashboardConfigService.js";
 import { createWidgetDataService } from "./services/widgetDataService.js";
-import { createWidgetConfigValidatorService } from "./services/widgetConfigValidator.js";
 
 const DEFAULT_DASHBOARD_CONFIG = {
   version: 1,
@@ -119,7 +118,6 @@ export default class DashboardPlugin extends AdminForthPlugin {
       this.options.dashboardConfigsResourceId,
     );
     const widgetDataService = createWidgetDataService(this.adminforth);
-    const widgetConfigValidatorService = createWidgetConfigValidatorService(this.adminforth);
 
     const ctx = {
       adminforth: this.adminforth,
@@ -127,7 +125,6 @@ export default class DashboardPlugin extends AdminForthPlugin {
       canEditDashboard,
       ...dashboardConfigService,
       ...widgetDataService,
-      ...widgetConfigValidatorService,
     };
 
     registerDashboardEndpoints(server, ctx);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/dashboard",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
@@ -9,7 +9,7 @@
     "access": "public"
   },
   "scripts": {
-    "build": "tsc && rsync -av --exclude 'node_modules' custom dist/",
+    "build": "rm -rf dist && tsc && rsync -av --exclude 'node_modules' custom dist/",
     "typecheck": "tsc --noEmit"
   },
   "keywords": [
@@ -21,7 +21,7 @@
   "description": "Dashboard plugin for AdminForth",
   "devDependencies": {
     "@types/node": "latest",
-    "adminforth": "^2.60.0",
+    "adminforth": "2.61.0-next.9",
     "semantic-release": "^24.2.1",
     "semantic-release-slack-bot": "^4.0.2",
     "typescript": "^5.7.3",

package/schema/api.ts

@@ -1,5 +1,5 @@
 import { toJSONSchema, z } from 'zod'
-import { StoredWidgetConfigSchema, WidgetConfigSchema } from './widget.js'
+import { EditableDashboardWidgetConfigSchema, StoredWidgetConfigSchema } from './widget.js'
 
 function toAdminForthJsonSchema(schema: z.ZodType) {
   return toJSONSchema(schema, { target: 'draft-7' })
@@ -17,13 +17,13 @@ export const DashboardGroupZodSchema = z.object({
   id: z.string(),
   label: z.string(),
   order: z.number(),
-})
+}).strict()
 
 export const DashboardConfigZodSchema = z.object({
   version: z.number(),
   groups: z.array(DashboardGroupZodSchema),
   widgets: z.array(StoredWidgetConfigSchema),
-})
+}).strict()
 
 export const DashboardResponseZodSchema = z.object({
   id: z.string(),
@@ -47,33 +47,42 @@ export const DashboardWidgetDataResponseZodSchema = z.union([
 ])
 
 export const SlugRequestZodSchema = z.object({
-  slug: z.string().optional(),
+  slug: z.string(),
+}).strict()
+
+export const SetDashboardConfigRequestZodSchema = z.object({
+  slug: z.string(),
+  config: DashboardConfigZodSchema,
 }).strict()
 
 export const GroupIdRequestZodSchema = z.object({
-  slug: z.string().optional(),
+  slug: z.string(),
   groupId: z.string(),
 }).strict()
 
 export const MoveGroupRequestZodSchema = z.object({
-  slug: z.string().optional(),
+  slug: z.string(),
   groupId: z.string(),
   direction: z.enum(['up', 'down']),
 }).strict()
 
+export const EditableDashboardGroupConfigZodSchema = z.object({
+  label: z.string(),
+}).strict()
+
 export const SetGroupConfigRequestZodSchema = z.object({
-  slug: z.string().optional(),
+  slug: z.string(),
   groupId: z.string(),
-  config: DashboardGroupZodSchema,
+  config: EditableDashboardGroupConfigZodSchema,
 }).strict()
 
 export const WidgetIdRequestZodSchema = z.object({
-  slug: z.string().optional(),
+  slug: z.string(),
   widgetId: z.string(),
 }).strict()
 
 export const WidgetDataRequestZodSchema = z.object({
-  slug: z.string().optional(),
+  slug: z.string(),
   widgetId: z.string(),
   pagination: z.object({
     page: z.number().int().positive(),
@@ -82,15 +91,15 @@ export const WidgetDataRequestZodSchema = z.object({
 }).strict()
 
 export const MoveWidgetRequestZodSchema = z.object({
-  slug: z.string().optional(),
+  slug: z.string(),
   widgetId: z.string(),
   direction: z.enum(['up', 'down']),
 }).strict()
 
 export const SetWidgetConfigRequestZodSchema = z.object({
-  slug: z.string().optional(),
+  slug: z.string(),
   widgetId: z.string(),
-  config: z.record(z.string(), z.unknown()),
+  config: EditableDashboardWidgetConfigSchema,
 }).strict()
 
 export const DashboardErrorResponseSchema = toAdminForthJsonSchema(DashboardErrorResponseZodSchema)
@@ -100,6 +109,7 @@ export const DashboardResponseSchema = toAdminForthJsonSchema(DashboardResponseZ
 export const DashboardApiResponseSchema = toAdminForthJsonSchema(DashboardApiResponseZodSchema)
 export const DashboardWidgetDataResponseSchema = toAdminForthJsonSchema(DashboardWidgetDataResponseZodSchema)
 export const SlugRequestSchema = toAdminForthJsonSchema(SlugRequestZodSchema)
+export const SetDashboardConfigRequestSchema = toAdminForthJsonSchema(SetDashboardConfigRequestZodSchema)
 export const GroupIdRequestSchema = toAdminForthJsonSchema(GroupIdRequestZodSchema)
 export const MoveGroupRequestSchema = toAdminForthJsonSchema(MoveGroupRequestZodSchema)
 export const SetGroupConfigRequestSchema = toAdminForthJsonSchema(SetGroupConfigRequestZodSchema)