@adminforth/dashboard 1.3.0 → 1.4.1

package/dist/endpoint/groups.d.ts

@@ -1,30 +1,11 @@
 import type { AdminUser, IHttpServer } from 'adminforth';
 import type { DashboardConfig } from '../custom/model/dashboard.types.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;
     getDashboardRecord: (slug: string) => Promise<DashboardRecord | null>;
     parseStoredDashboardConfig: (config: unknown) => DashboardConfig;
-    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;
-    };
+    persistDashboardConfig: (dashboard: DashboardRecord, config: DashboardConfig) => Promise<PersistedDashboardResponse>;
 };
 export declare function registerGroupEndpoints(server: IHttpServer, ctx: GroupEndpointsContext): void;
 export {};

package/dist/endpoint/groups.js

@@ -21,8 +21,7 @@ export function registerGroupEndpoints(server, ctx) {
                 response.setStatus(403);
                 return { error: 'Dashboard edit is not allowed' };
             }
-            const slug = String((body === null || body === void 0 ? void 0 : body.slug) || 'default');
-            const dashboard = yield ctx.getDashboardRecord(slug);
+            const dashboard = yield ctx.getDashboardRecord(body.slug);
             if (!dashboard) {
                 response.setStatus(404);
                 return { error: 'Dashboard not found' };
@@ -48,9 +47,8 @@ export function registerGroupEndpoints(server, ctx) {
                 response.setStatus(403);
                 return { error: 'Dashboard edit is not allowed' };
             }
-            const slug = String((body === null || body === void 0 ? void 0 : body.slug) || 'default');
-            const groupId = String((body === null || body === void 0 ? void 0 : body.groupId) || '');
-            const dashboard = yield ctx.getDashboardRecord(slug);
+            const groupId = body.groupId;
+            const dashboard = yield ctx.getDashboardRecord(body.slug);
             if (!dashboard) {
                 response.setStatus(404);
                 return { error: 'Dashboard not found' };
@@ -61,8 +59,10 @@ export function registerGroupEndpoints(server, ctx) {
                 response.setStatus(404);
                 return { error: 'Dashboard group not found' };
             }
+            const nextGroup = Object.assign(Object.assign({}, body.config), { id: group.id, order: group.order });
             return ctx.persistDashboardConfig(dashboard, Object.assign(Object.assign({}, config), { groups: config.groups.map((item) => item.id === groupId
-                    ? Object.assign(Object.assign({}, body.config), { id: group.id, order: group.order }) : item) }));
+                    ? nextGroup
+                    : item) }));
         }),
     });
     server.endpoint({
@@ -76,24 +76,27 @@ export function registerGroupEndpoints(server, ctx) {
                 response.setStatus(403);
                 return { error: 'Dashboard edit is not allowed' };
             }
-            const slug = String((body === null || body === void 0 ? void 0 : body.slug) || 'default');
-            const groupId = String((body === null || body === void 0 ? void 0 : body.groupId) || '');
-            const direction = (body === null || body === void 0 ? void 0 : body.direction) === 'down' ? 'down' : 'up';
-            const dashboard = yield ctx.getDashboardRecord(slug);
+            const dashboard = yield ctx.getDashboardRecord(body.slug);
             if (!dashboard) {
                 response.setStatus(404);
                 return { error: 'Dashboard not found' };
             }
             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];
             const [group] = reorderedGroups.splice(currentIndex, 1);
@@ -112,9 +115,8 @@ export function registerGroupEndpoints(server, ctx) {
                 response.setStatus(403);
                 return { error: 'Dashboard edit is not allowed' };
             }
-            const slug = String((body === null || body === void 0 ? void 0 : body.slug) || 'default');
-            const groupId = String((body === null || body === void 0 ? void 0 : body.groupId) || '');
-            const dashboard = yield ctx.getDashboardRecord(slug);
+            const groupId = body.groupId;
+            const dashboard = yield ctx.getDashboardRecord(body.slug);
             if (!dashboard) {
                 response.setStatus(404);
                 return { error: 'Dashboard not found' };

package/dist/endpoint/widgets.d.ts

@@ -1,19 +1,17 @@
 import type { AdminUser, IHttpServer } from 'adminforth';
-import type { DashboardConfig, DashboardWidgetConfig } from '../custom/model/dashboard.types.js';
-import type { DashboardWidgetConfigValidationError } from '../schema/widget.js';
+import type { DashboardConfig, DashboardVariables, DashboardWidgetConfig } from '../custom/model/dashboard.types.js';
 import type { DashboardRecord, PersistedDashboardResponse } from '../services/dashboardConfigService.js';
 type WidgetEndpointsContext = {
     canEditDashboard: (adminUser: AdminUser) => boolean;
     getDashboardRecord: (slug: string) => Promise<DashboardRecord | null>;
     parseStoredDashboardConfig: (config: unknown) => DashboardConfig;
     persistDashboardConfig: (dashboard: DashboardRecord, config: DashboardConfig) => Promise<PersistedDashboardResponse>;
-    buildDashboardResponse: (dashboard: DashboardRecord) => PersistedDashboardResponse;
-    validateDashboardWidgetApiConfig: (widget: DashboardWidgetConfig) => DashboardWidgetConfigValidationError[];
     getWidgetData: (widget: DashboardWidgetConfig, options?: {
         pagination?: {
             page: number;
             pageSize: number;
         };
+        variables?: DashboardVariables;
     }) => Promise<unknown>;
 };
 export declare function registerWidgetEndpoints(server: IHttpServer, ctx: WidgetEndpointsContext): void;

package/dist/endpoint/widgets.js

@@ -8,35 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { randomUUID } from 'crypto';
-import { normalizeDashboardWidgetConfig, } from '../custom/model/dashboard.types.js';
 import { DashboardApiResponseSchema, DashboardWidgetDataResponseSchema, GroupIdRequestSchema, MoveWidgetRequestSchema, SetWidgetConfigRequestSchema, WidgetDataRequestSchema, WidgetIdRequestSchema, } from '../schema/api.js';
-import { StoredWidgetConfigSchema } from '../schema/widget.js';
-function formatWidgetConfigValidationErrors(error) {
-    return error.issues.map((issue) => ({
-        field: issue.path.length ? formatWidgetConfigFieldPath(issue.path.map(String).join('.')) : 'config',
-        message: issue.message,
-    }));
-}
-function formatWidgetConfigApiValidationErrors(errors) {
-    return errors.map((error) => (Object.assign(Object.assign({}, error), { field: formatWidgetConfigFieldPath(error.field) })));
-}
-function formatWidgetConfigFieldPath(field) {
-    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) => { var _a; return (_a = fieldAliases.get(segment)) !== null && _a !== void 0 ? _a : segment; })
-        .join('.');
-}
 export function registerWidgetEndpoints(server, ctx) {
     server.endpoint({
         method: 'POST',
@@ -49,23 +21,21 @@ export function registerWidgetEndpoints(server, ctx) {
                 response.setStatus(403);
                 return { error: 'Dashboard edit is not allowed' };
             }
-            const slug = String((body === null || body === void 0 ? void 0 : body.slug) || 'default');
-            const groupId = String((body === null || body === void 0 ? void 0 : body.groupId) || '');
-            const dashboard = yield ctx.getDashboardRecord(slug);
+            const dashboard = yield ctx.getDashboardRecord(body.slug);
             if (!dashboard) {
                 response.setStatus(404);
                 return { error: 'Dashboard not found' };
             }
             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 = {
                 id: `widget_${randomUUID()}`,
-                group_id: groupId,
+                group_id: body.groupId,
                 label: 'New widget',
                 size: 'small',
                 order: nextOrder,
@@ -85,16 +55,13 @@ export function registerWidgetEndpoints(server, ctx) {
                 response.setStatus(403);
                 return { error: 'Dashboard edit is not allowed' };
             }
-            const slug = String((body === null || body === void 0 ? void 0 : body.slug) || 'default');
-            const widgetId = String((body === null || body === void 0 ? void 0 : body.widgetId) || '');
-            const direction = (body === null || body === void 0 ? void 0 : body.direction) === 'down' ? 'down' : 'up';
-            const dashboard = yield ctx.getDashboardRecord(slug);
+            const dashboard = yield ctx.getDashboardRecord(body.slug);
             if (!dashboard) {
                 response.setStatus(404);
                 return { error: 'Dashboard not found' };
             }
             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' };
@@ -102,10 +69,16 @@ export function registerWidgetEndpoints(server, ctx) {
             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];
             const [movedWidget] = reorderedWidgets.splice(currentIndex, 1);
@@ -128,15 +101,13 @@ export function registerWidgetEndpoints(server, ctx) {
                 response.setStatus(403);
                 return { error: 'Dashboard edit is not allowed' };
             }
-            const slug = String((body === null || body === void 0 ? void 0 : body.slug) || 'default');
-            const widgetId = String((body === null || body === void 0 ? void 0 : body.widgetId) || '');
-            const dashboard = yield ctx.getDashboardRecord(slug);
+            const dashboard = yield ctx.getDashboardRecord(body.slug);
             if (!dashboard) {
                 response.setStatus(404);
                 return { error: 'Dashboard not found' };
             }
             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);
                 return { error: 'Dashboard widget not found' };
@@ -155,38 +126,22 @@ export function registerWidgetEndpoints(server, ctx) {
                 response.setStatus(403);
                 return { error: 'Dashboard edit is not allowed' };
             }
-            const slug = String((body === null || body === void 0 ? void 0 : body.slug) || 'default');
-            const widgetId = String((body === null || body === void 0 ? void 0 : body.widgetId) || '');
-            const dashboard = yield ctx.getDashboardRecord(slug);
+            const dashboard = yield ctx.getDashboardRecord(body.slug);
             if (!dashboard) {
                 response.setStatus(404);
                 return { error: 'Dashboard not found' };
             }
             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;
-            const apiValidationErrors = ctx.validateDashboardWidgetApiConfig(typedWidgetConfig);
-            if (apiValidationErrors.length) {
-                response.setStatus(422);
-                return {
-                    error: 'Invalid widget config',
-                    validationErrors: formatWidgetConfigApiValidationErrors(apiValidationErrors),
-                };
-            }
-            return ctx.persistDashboardConfig(dashboard, Object.assign(Object.assign({}, config), { widgets: config.widgets.map((item) => item.id === widgetId
-                    ? Object.assign(Object.assign({}, typedWidgetConfig), { id: widget.id, group_id: widget.group_id, order: widget.order }) : item) }));
+            const typedWidgetConfig = body.config;
+            const nextWidget = Object.assign(Object.assign({}, typedWidgetConfig), { id: widget.id, group_id: widget.group_id, order: widget.order });
+            return ctx.persistDashboardConfig(dashboard, Object.assign(Object.assign({}, config), { widgets: config.widgets.map((item) => item.id === body.widgetId
+                    ? nextWidget
+                    : item) }));
         }),
     });
     server.endpoint({
@@ -196,15 +151,13 @@ export function registerWidgetEndpoints(server, ctx) {
         request_schema: WidgetDataRequestSchema,
         response_schema: DashboardWidgetDataResponseSchema,
         handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body, response }) {
-            const slug = String((body === null || body === void 0 ? void 0 : body.slug) || 'default');
-            const widgetId = String((body === null || body === void 0 ? void 0 : body.widgetId) || '');
-            const dashboard = yield ctx.getDashboardRecord(slug);
+            const dashboard = yield ctx.getDashboardRecord(body.slug);
             if (!dashboard) {
                 response.setStatus(404);
                 return { error: 'Dashboard not found' };
             }
             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' };
@@ -212,7 +165,8 @@ export function registerWidgetEndpoints(server, ctx) {
             return {
                 widget,
                 data: yield ctx.getWidgetData(widget, {
-                    pagination: body === null || body === void 0 ? void 0 : body.pagination,
+                    pagination: body.pagination,
+                    variables: widget.variables,
                 }),
             };
         }),

package/dist/index.js

@@ -15,7 +15,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,
     groups: [{
@@ -112,8 +111,7 @@ export default class DashboardPlugin extends AdminForthPlugin {
     setupEndpoints(server) {
         const dashboardConfigService = createDashboardConfigService(this.adminforth, this.options.dashboardConfigsResourceId);
         const widgetDataService = createWidgetDataService(this.adminforth);
-        const widgetConfigValidatorService = createWidgetConfigValidatorService(this.adminforth);
-        const ctx = Object.assign(Object.assign(Object.assign({ adminforth: this.adminforth, dashboardConfigsResourceId: this.options.dashboardConfigsResourceId, canEditDashboard }, dashboardConfigService), widgetDataService), widgetConfigValidatorService);
+        const ctx = Object.assign(Object.assign({ adminforth: this.adminforth, dashboardConfigsResourceId: this.options.dashboardConfigsResourceId, canEditDashboard }, dashboardConfigService), widgetDataService);
         registerDashboardEndpoints(server, ctx);
         registerGroupEndpoints(server, ctx);
         registerWidgetEndpoints(server, ctx);