@adminforth/dashboard 1.3.0 → 1.4.0

package/dist/custom/queries/useWidgetData.d.ts

@@ -6,6 +6,7 @@ export declare function useWidgetData(slug: Ref<string>, widgetId: Ref<string>,
             id: string;
             group_id: string;
             label?: string | undefined;
+            variables?: import("../model/dashboard.types.js").DashboardVariables | undefined;
             size?: import("../model/dashboard.types.js").DashboardWidgetSize | undefined;
             width?: number | undefined;
             height?: number | undefined;
@@ -17,6 +18,7 @@ export declare function useWidgetData(slug: Ref<string>, widgetId: Ref<string>,
             id: string;
             group_id: string;
             label?: string | undefined;
+            variables?: import("../model/dashboard.types.js").DashboardVariables | undefined;
             size?: import("../model/dashboard.types.js").DashboardWidgetSize | undefined;
             width?: number | undefined;
             height?: number | undefined;
@@ -89,6 +91,7 @@ export declare function useWidgetData(slug: Ref<string>, widgetId: Ref<string>,
             id: string;
             group_id: string;
             label?: string | undefined;
+            variables?: import("../model/dashboard.types.js").DashboardVariables | undefined;
             size?: import("../model/dashboard.types.js").DashboardWidgetSize | undefined;
             width?: number | undefined;
             height?: number | undefined;
@@ -199,11 +202,16 @@ export declare function useWidgetData(slug: Ref<string>, widgetId: Ref<string>,
                     };
                     filters?: any;
                 }[];
+                calcs?: {
+                    calc: string;
+                    as: string;
+                }[] | undefined;
             };
         } | {
             id: string;
             group_id: string;
             label?: string | undefined;
+            variables?: import("../model/dashboard.types.js").DashboardVariables | undefined;
             size?: import("../model/dashboard.types.js").DashboardWidgetSize | undefined;
             width?: number | undefined;
             height?: number | undefined;
@@ -282,6 +290,7 @@ export declare function useWidgetData(slug: Ref<string>, widgetId: Ref<string>,
             id: string;
             group_id: string;
             label?: string | undefined;
+            variables?: import("../model/dashboard.types.js").DashboardVariables | undefined;
             size?: import("../model/dashboard.types.js").DashboardWidgetSize | undefined;
             width?: number | undefined;
             height?: number | undefined;
@@ -366,6 +375,7 @@ export declare function useWidgetData(slug: Ref<string>, widgetId: Ref<string>,
             id: string;
             group_id: string;
             label?: string | undefined;
+            variables?: import("../model/dashboard.types.js").DashboardVariables | undefined;
             size?: import("../model/dashboard.types.js").DashboardWidgetSize | undefined;
             width?: number | undefined;
             height?: number | undefined;
@@ -450,6 +460,7 @@ export declare function useWidgetData(slug: Ref<string>, widgetId: Ref<string>,
             id: string;
             group_id: string;
             label?: string | undefined;
+            variables?: import("../model/dashboard.types.js").DashboardVariables | undefined;
             size?: import("../model/dashboard.types.js").DashboardWidgetSize | undefined;
             width?: number | undefined;
             height?: number | undefined;
@@ -461,6 +472,7 @@ export declare function useWidgetData(slug: Ref<string>, widgetId: Ref<string>,
             id: string;
             group_id: string;
             label?: string | undefined;
+            variables?: import("../model/dashboard.types.js").DashboardVariables | undefined;
             size?: import("../model/dashboard.types.js").DashboardWidgetSize | undefined;
             width?: number | undefined;
             height?: number | undefined;
@@ -533,6 +545,7 @@ export declare function useWidgetData(slug: Ref<string>, widgetId: Ref<string>,
             id: string;
             group_id: string;
             label?: string | undefined;
+            variables?: import("../model/dashboard.types.js").DashboardVariables | undefined;
             size?: import("../model/dashboard.types.js").DashboardWidgetSize | undefined;
             width?: number | undefined;
             height?: number | undefined;
@@ -643,11 +656,16 @@ export declare function useWidgetData(slug: Ref<string>, widgetId: Ref<string>,
                     };
                     filters?: any;
                 }[];
+                calcs?: {
+                    calc: string;
+                    as: string;
+                }[] | undefined;
             };
         } | {
             id: string;
             group_id: string;
             label?: string | undefined;
+            variables?: import("../model/dashboard.types.js").DashboardVariables | undefined;
             size?: import("../model/dashboard.types.js").DashboardWidgetSize | undefined;
             width?: number | undefined;
             height?: number | undefined;
@@ -726,6 +744,7 @@ export declare function useWidgetData(slug: Ref<string>, widgetId: Ref<string>,
             id: string;
             group_id: string;
             label?: string | undefined;
+            variables?: import("../model/dashboard.types.js").DashboardVariables | undefined;
             size?: import("../model/dashboard.types.js").DashboardWidgetSize | undefined;
             width?: number | undefined;
             height?: number | undefined;
@@ -810,6 +829,7 @@ export declare function useWidgetData(slug: Ref<string>, widgetId: Ref<string>,
             id: string;
             group_id: string;
             label?: string | undefined;
+            variables?: import("../model/dashboard.types.js").DashboardVariables | undefined;
             size?: import("../model/dashboard.types.js").DashboardWidgetSize | undefined;
             width?: number | undefined;
             height?: number | undefined;

package/dist/custom/skills/adminforth-dashboard/SKILL.md

@@ -41,6 +41,7 @@ If the user asks how the schema works, how to implement the API, or how to chang
 Use these tools whenever available:
 
 - `dashboard_get_config`
+- `dashboard_set_dashboard_config`
 - `dashboard_add_dashboard_group`
 - `dashboard_set_dashboard_group_config`
 - `dashboard_move_dashboard_group`
@@ -58,6 +59,7 @@ If a dashboard tool is known by name but its argument schema is not loaded, call
 Do not pass fields between dashboard tools by analogy. Use each tool's schema.
 
 - `dashboard_add_dashboard_group` creates a new group. It accepts the dashboard slug only. Never pass `groupId` to this tool.
+- `dashboard_set_dashboard_config` replaces the full dashboard config. Use it when the user explicitly asks to edit the whole dashboard config.
 - `dashboard_add_dashboard_widget` creates a widget inside an existing group. Use it when you already have a `groupId`.
 - `dashboard_set_dashboard_group_config`, `dashboard_move_dashboard_group`, and `dashboard_remove_dashboard_group` operate on an existing group and need `groupId`.
 - `dashboard_set_widget_config`, `dashboard_move_dashboard_widget`, `dashboard_remove_dashboard_widget`, and `dashboard_get_dashboard_widget_data` operate on an existing widget and need `widgetId`.
@@ -113,6 +115,24 @@ For group requests:
 
 If slug is missing, use `default`.
 
+## Dashboard Config Workflow
+
+Use `dashboard_set_dashboard_config` only when the user explicitly asks to edit the whole dashboard root config.
+
+For requests like:
+
+- "update root dashboard config"
+- "replace the whole dashboard config"
+
+do this:
+
+1. Call `dashboard_get_config`.
+2. Modify the returned root config, preserving existing `version`, `groups`, and `widgets` unless the user asked to change them.
+3. Call `dashboard_set_dashboard_config` with the full updated config.
+4. Return a short summary of the root-level fields changed.
+
+Do not use `dashboard_set_dashboard_config` to store reusable widget variables.
+
 ## Widget Config Rules
 
 Use the current schema keys exactly:
@@ -124,6 +144,93 @@ Use the current schema keys exactly:
 - Use `group_by`, not `groupBy`.
 - Use `order_by`, not `orderBy`.
 - Use `page_size`, not `pageSize`.
-- For funnel charts, use `query.steps` as an ordered array of `{ name, resource, metric, filters }` steps.
+- For step-based chart queries, use `query.steps` as an ordered array of `{ name, resource, metric, filters }` steps and add `query.calcs` when derived fields are needed.
 - Use `card` for KPI and gauge widget view config.
 - Use `pivot` for pivot table view config.
+- Use `variables` for reusable static maps or constants at widget level.
+- In `query.calcs`, use `lookup($variables.some.map, row_field, default_number)` to read a numeric value from a variable map by the current row/group field.
+
+## Variables And Lookup Calcs
+
+Widget config can define variables:
+
+```yaml
+variables:
+  token_prices_per_1m:
+    input:
+      gpt-4.1: 2.00
+      gpt-4.1-mini: 0.40
+      gpt-4o-mini: 0.15
+    output:
+      gpt-4.1: 8.00
+      gpt-4.1-mini: 1.60
+      gpt-4o-mini: 0.60
+    cached:
+      gpt-4.1: 0.50
+      gpt-4.1-mini: 0.10
+      gpt-4o-mini: 0.075
+```
+
+Use variables when a calculation needs a static rate table, threshold table, coefficient map, or other reusable constants. In calcs, `lookup($variables.path.to.map, field_name, 0)` returns the value from the map using `field_name` from the current row/group. The third argument is the numeric fallback when the key is missing.
+
+Example widget:
+
+```yaml
+target: chart
+label: Model costs
+size: large
+variables:
+  token_prices_per_1m:
+    input:
+      gpt-4.1: 2.00
+      gpt-4.1-mini: 0.40
+      gpt-4o-mini: 0.15
+    output:
+      gpt-4.1: 8.00
+      gpt-4.1-mini: 1.60
+      gpt-4o-mini: 0.60
+    cached:
+      gpt-4.1: 0.50
+      gpt-4.1-mini: 0.10
+      gpt-4o-mini: 0.075
+
+chart:
+  type: stacked_bar
+  title: LLM costs by model
+  x:
+    field: model
+    label: Model
+  y:
+    - field: input_cost
+      label: Input
+      format: currency
+    - field: output_cost
+      label: Output
+      format: currency
+    - field: cached_cost
+      label: Cached
+      format: currency
+
+query:
+  resource: model_usage
+  select:
+    - field: model
+    - agg: sum
+      field: input_tokens
+      as: input_tokens
+    - agg: sum
+      field: output_tokens
+      as: output_tokens
+    - agg: sum
+      field: cached_tokens
+      as: cached_tokens
+  group_by:
+    - model
+  calcs:
+    - calc: input_tokens / 1000000 * lookup($variables.token_prices_per_1m.input, model, 0)
+      as: input_cost
+    - calc: output_tokens / 1000000 * lookup($variables.token_prices_per_1m.output, model, 0)
+      as: output_cost
+    - calc: cached_tokens / 1000000 * lookup($variables.token_prices_per_1m.cached, model, 0)
+      as: cached_cost
+```

package/dist/custom/widgets/chart/ChartWidget.vue

@@ -69,10 +69,10 @@
 
     <StackedBarChart
       v-else-if="chartConfig?.type === 'stacked_bar'"
-      :rows="rows"
+      :rows="stackedBarRows"
       :x-field="xField"
-      :y-field="yField"
-      :series-field="seriesField"
+      :y-field="stackedBarYField"
+      :series-field="stackedBarSeriesField"
       :colors="chartConfig.colors"
       :height="chartHeight"
     />
@@ -155,6 +155,21 @@ const valueField = computed(() => chartConfig.value?.value?.field || columns.val
 const pieRows = computed(() => rows.value)
 const pieLabelField = computed(() => labelField.value)
 const pieValueField = computed(() => valueField.value)
+const stackedBarYItems = computed(() => {
+  const y = chartConfig.value?.y
+  return Array.isArray(y) ? y : []
+})
+const stackedBarRows = computed(() => {
+  if (chartConfig.value?.type !== 'stacked_bar' || !stackedBarYItems.value.length) {
+    return rows.value
+  }
+
+  return rows.value.flatMap((row) => stackedBarYItems.value.map((item) => ({
+    [xField.value]: row[xField.value],
+    __series: item.label ?? item.field,
+    __value: row[item.field],
+  })))
+})
 const barRows = computed(() => {
   const bucketField = chartConfig.value?.type === 'histogram'
     ? chartConfig.value.x?.field
@@ -178,6 +193,8 @@ const barRows = computed(() => {
 const barLabelField = computed(() => chartConfig.value?.type === 'histogram' && chartConfig.value.buckets ? 'label' : xField.value)
 const barValueField = computed(() => chartConfig.value?.type === 'histogram' && chartConfig.value.buckets ? 'count' : yField.value)
 const seriesField = computed(() => chartConfig.value?.series?.field || columns.value[2] || '')
+const stackedBarYField = computed(() => stackedBarYItems.value.length ? '__value' : yField.value)
+const stackedBarSeriesField = computed(() => stackedBarYItems.value.length ? '__series' : seriesField.value)
 const lineSeriesName = computed(() => {
   const y = chartConfig.value?.y
   return Array.isArray(y) ? y[0]?.label : undefined

package/dist/endpoint/dashboard.d.ts

@@ -1,7 +1,12 @@
-import type { IHttpServer } from 'adminforth';
-import type { DashboardRecord } from '../services/dashboardConfigService.js';
+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 { DashboardRecord, PersistedDashboardResponse } from '../services/dashboardConfigService.js';
 type DashboardEndpointsContext = {
+    canEditDashboard: (adminUser: AdminUser) => boolean;
     getDashboardRecord: (slug: string) => Promise<DashboardRecord | null>;
+    persistDashboardConfig: (dashboard: DashboardRecord, config: DashboardConfig) => Promise<PersistedDashboardResponse>;
+    validateDashboardWidgetApiConfig: (widget: DashboardWidgetConfig) => DashboardWidgetConfigValidationError[];
 };
 export declare function registerDashboardEndpoints(server: IHttpServer, ctx: DashboardEndpointsContext): void;
 export {};

package/dist/endpoint/dashboard.js

@@ -7,8 +7,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { DashboardApiResponseSchema, SlugRequestSchema } from '../schema/api.js';
+import { normalizeDashboardConfig } from '../custom/model/dashboard.types.js';
+import { DashboardApiResponseSchema, DashboardConfigZodSchema, SetDashboardConfigRequestSchema, SlugRequestSchema, } from '../schema/api.js';
 import { buildDashboardResponse } from '../services/dashboardConfigService.js';
+function formatDashboardConfigValidationErrors(error) {
+    return error.issues.map((issue) => ({
+        field: issue.path.length ? issue.path.map(String).join('.') : 'config',
+        message: issue.message,
+    }));
+}
 export function registerDashboardEndpoints(server, ctx) {
     server.endpoint({
         method: 'POST',
@@ -26,4 +33,41 @@ export function registerDashboardEndpoints(server, ctx) {
             return buildDashboardResponse(dashboard);
         }),
     });
+    server.endpoint({
+        method: 'POST',
+        path: '/dashboard/set_dashboard_config',
+        description: 'Replaces one dashboard configuration, including groups and widgets. Superadmin only.',
+        request_schema: SetDashboardConfigRequestSchema,
+        response_schema: DashboardApiResponseSchema,
+        handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body, adminUser, response }) {
+            if (!ctx.canEditDashboard(adminUser)) {
+                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);
+            if (!dashboard) {
+                response.setStatus(404);
+                return { error: 'Dashboard not found' };
+            }
+            const normalizedConfig = normalizeDashboardConfig(body === null || body === void 0 ? void 0 : body.config);
+            const parsedConfig = DashboardConfigZodSchema.safeParse(normalizedConfig);
+            if (!parsedConfig.success) {
+                response.setStatus(422);
+                return {
+                    error: 'Invalid dashboard config',
+                    validationErrors: formatDashboardConfigValidationErrors(parsedConfig.error),
+                };
+            }
+            const widgetValidationErrors = parsedConfig.data.widgets.flatMap((widget, index) => (ctx.validateDashboardWidgetApiConfig(widget).map((error) => (Object.assign(Object.assign({}, error), { field: `widgets.${index}.${error.field}` })))));
+            if (widgetValidationErrors.length) {
+                response.setStatus(422);
+                return {
+                    error: 'Invalid dashboard config',
+                    validationErrors: widgetValidationErrors,
+                };
+            }
+            return ctx.persistDashboardConfig(dashboard, parsedConfig.data);
+        }),
+    });
 }

package/dist/endpoint/widgets.d.ts

@@ -1,5 +1,5 @@
 import type { AdminUser, IHttpServer } from 'adminforth';
-import type { DashboardConfig, DashboardWidgetConfig } from '../custom/model/dashboard.types.js';
+import type { DashboardConfig, DashboardVariables, DashboardWidgetConfig } from '../custom/model/dashboard.types.js';
 import type { DashboardWidgetConfigValidationError } from '../schema/widget.js';
 import type { DashboardRecord, PersistedDashboardResponse } from '../services/dashboardConfigService.js';
 type WidgetEndpointsContext = {
@@ -14,6 +14,7 @@ type WidgetEndpointsContext = {
             page: number;
             pageSize: number;
         };
+        variables?: DashboardVariables;
     }) => Promise<unknown>;
 };
 export declare function registerWidgetEndpoints(server: IHttpServer, ctx: WidgetEndpointsContext): void;

package/dist/endpoint/widgets.js

@@ -213,6 +213,7 @@ export function registerWidgetEndpoints(server, ctx) {
                 widget,
                 data: yield ctx.getWidgetData(widget, {
                     pagination: body === null || body === void 0 ? void 0 : body.pagination,
+                    variables: widget.variables,
                 }),
             };
         }),