@adminforth/dashboard 1.9.0 → 1.10.0

package/dist/schema/api.js

@@ -159,18 +159,13 @@ export const ConfigurePieChartWidgetRequestZodSchema = configureWidgetRequestSch
 export const ConfigureHistogramChartWidgetRequestZodSchema = configureWidgetRequestSchema(ConfigurableHistogramChartWidgetConfigSchema);
 export const ConfigureFunnelChartWidgetRequestZodSchema = configureWidgetRequestSchema(ConfigurableFunnelChartWidgetConfigSchema);
 export const ConfigurePivotTableWidgetRequestZodSchema = configureWidgetRequestSchema(ConfigurablePivotTableWidgetConfigSchema);
-export const DashboardMutationResponseZodSchema = z.union([
-    z.object({
-        ok: z.literal(true),
-        slug: z.string(),
-        widgetId: z.string().optional(),
-        groupId: z.string().optional(),
-        target: z.string().optional(),
-        revision: z.number().optional(),
-    }).strict(),
-    DashboardErrorResponseZodSchema,
-]);
-export const DashboardApiResponseSchema = toJSONSchema(DashboardApiResponseZodSchema, { target: 'draft-07' });
+export const DashboardMutationResponseZodSchema = z.object({
+    ok: z.boolean(),
+    error: z.string().optional(),
+    groupId: z.string().optional(),
+    widgetId: z.string().optional(),
+}).strict();
+export const DashboardApiResponseSchema = toJSONSchema(z.unknown(), { target: 'draft-07' });
 export const DashboardWidgetDataResponseSchema = toJSONSchema(DashboardWidgetDataResponseZodSchema, { target: 'draft-07' });
 export const SlugRequestSchema = toJSONSchema(SlugRequestZodSchema, { target: 'draft-07' });
 export const GroupIdRequestSchema = toJSONSchema(GroupIdRequestZodSchema, { target: 'draft-07' });

package/dist/services/calc-evaluator.d.ts

@@ -1 +1,2 @@
-export declare function evaluateCalc(calc: string, values: Record<string, unknown>): any;
+import type { DashboardVariables } from '../custom/model/dashboard.types.js';
+export declare function evaluateCalc(calc: string, values: Record<string, unknown>, variables?: DashboardVariables): any;

package/dist/services/calc-evaluator.js

@@ -1,4 +1,5 @@
 import { Parser } from 'expr-eval-fork';
+const LOOKUP_VARIABLE_PATH_RE = /lookup\(\s*\$variables((?:\.[a-zA-Z_][a-zA-Z0-9_]*)+)\s*,/g;
 const CALC_PARSER_OPTIONS = {
     allowMemberAccess: false,
     operators: {
@@ -12,9 +13,25 @@ const CALC_PARSER_OPTIONS = {
         random: false,
     },
 };
-const CALC_PARSER = new Parser(CALC_PARSER_OPTIONS);
-export function evaluateCalc(calc, values) {
-    return CALC_PARSER.parse(calc).evaluate(normalizeCalcValues(values));
+export function evaluateCalc(calc, values, variables = {}) {
+    const parser = createCalcParser(variables);
+    return parser.parse(normalizeLookupPaths(calc)).evaluate(normalizeCalcValues(values));
+}
+function createCalcParser(variables) {
+    const parser = new Parser(CALC_PARSER_OPTIONS);
+    parser.functions.lookup = (path, key, defaultValue = 0) => {
+        const map = resolveVariablePath(variables, String(path));
+        const value = isRecord(map) && Object.prototype.hasOwnProperty.call(map, String(key))
+            ? map[String(key)]
+            : defaultValue;
+        return toFiniteNumber(value);
+    };
+    return parser;
+}
+function normalizeLookupPaths(calc) {
+    return calc.replace(LOOKUP_VARIABLE_PATH_RE, (_match, path) => {
+        return `lookup("${path.replace(/^\./, '')}",`;
+    });
 }
 function normalizeCalcValues(values) {
     return Object.fromEntries(Object.entries(values).map(([key, value]) => [
@@ -26,3 +43,12 @@ function toFiniteNumber(value) {
     const numberValue = typeof value === 'number' ? value : Number(value);
     return Number.isFinite(numberValue) ? numberValue : 0;
 }
+function resolveVariablePath(variables, path) {
+    return path
+        .split('.')
+        .filter(Boolean)
+        .reduce((current, segment) => isRecord(current) ? current[segment] : undefined, variables);
+}
+function isRecord(value) {
+    return typeof value === 'object' && value !== null;
+}

package/dist/services/widgetDataService.js

@@ -175,7 +175,7 @@ function getAggregateRows(adminforth, resourceId, baseFilters, select, groupBy)
 function buildCalculatedRow(baseValues, select, calcs = [], variables) {
     const values = Object.assign({}, baseValues);
     for (const item of [...select.filter(isCalcSelectItem), ...calcs]) {
-        values[item.as] = evaluateCalc(item.calc, values);
+        values[item.as] = evaluateCalc(item.calc, values, variables);
     }
     return values;
 }
@@ -190,7 +190,7 @@ function buildPlainRow(row, select, calcs = [], variables) {
         }
     }
     for (const item of [...select.filter(isCalcSelectItem), ...calcs]) {
-        values[item.as] = evaluateCalc(item.calc, values);
+        values[item.as] = evaluateCalc(item.calc, values, variables);
     }
     return values;
 }

package/endpoint/groups.ts

@@ -6,7 +6,7 @@ import type {
   DashboardGroupConfig,
 } from '../custom/model/dashboard.types.js';
 import {
-  DashboardApiResponseSchema,
+  DashboardMutationResponseSchema,
   GroupIdRequestSchema,
   MoveGroupRequestSchema,
   SetGroupConfigRequestSchema,
@@ -37,13 +37,14 @@ export function registerGroupEndpoints(
     path: '/dashboard/add_dashboard_group',
     description: 'Adds a new group to a dashboard configuration. Superadmin only.',
     request_schema: SlugRequestSchema,
-    response_schema: DashboardApiResponseSchema,
+    response_schema: DashboardMutationResponseSchema,
     handler: async ({ body, adminUser, response }) => {
       if (!ctx.canEditDashboard(adminUser)) {
         response.setStatus(403);
-        return { error: 'Dashboard edit is not allowed' };
+        return { ok: false, error: 'Dashboard edit is not allowed' };
       }
 
+      let groupId: string | null = null;
       const updatedDashboard = await ctx.updateDashboardConfig(body.slug, (config) => {
         const nextOrder = config.groups.length + 1;
         const group: DashboardGroupConfig = {
@@ -51,6 +52,7 @@ export function registerGroupEndpoints(
           label: 'New group',
           order: nextOrder,
         };
+        groupId = group.id;
 
         return {
           ...config,
@@ -60,10 +62,10 @@ export function registerGroupEndpoints(
 
       if (!updatedDashboard) {
         response.setStatus(404);
-        return { error: 'Dashboard not found' };
+        return { ok: false, error: 'Dashboard not found' };
       }
 
-      return updatedDashboard;
+      return { ok: true, groupId };
     },
   });
 
@@ -72,11 +74,11 @@ export function registerGroupEndpoints(
     path: '/dashboard/set_dashboard_group_config',
     description: 'Replaces editable JSON configuration for a dashboard group while preserving group id and order. Superadmin only.',
     request_schema: SetGroupConfigRequestSchema,
-    response_schema: DashboardApiResponseSchema,
+    response_schema: DashboardMutationResponseSchema,
     handler: async ({ body, adminUser, response }) => {
       if (!ctx.canEditDashboard(adminUser)) {
         response.setStatus(403);
-        return { error: 'Dashboard edit is not allowed' };
+        return { ok: false, error: 'Dashboard edit is not allowed' };
       }
 
       const groupId = body.groupId;
@@ -105,15 +107,15 @@ export function registerGroupEndpoints(
 
       if (!updatedDashboard) {
         response.setStatus(404);
-        return { error: 'Dashboard not found' };
+        return { ok: false, error: 'Dashboard not found' };
       }
 
       if (mutationError) {
         response.setStatus(404);
-        return { error: mutationError };
+        return { ok: false, error: mutationError };
       }
 
-      return updatedDashboard;
+      return { ok: true };
     },
   });
   
@@ -122,11 +124,11 @@ export function registerGroupEndpoints(
     path: '/dashboard/move_dashboard_group',
     description: 'Moves a dashboard group up or down in its dashboard. Superadmin only.',
     request_schema: MoveGroupRequestSchema,
-    response_schema: DashboardApiResponseSchema,
+    response_schema: DashboardMutationResponseSchema,
     handler: async ({ body, adminUser, response }) => {
       if (!ctx.canEditDashboard(adminUser)) {
         response.setStatus(403);
-        return { error: 'Dashboard edit is not allowed' };
+        return { ok: false, error: 'Dashboard edit is not allowed' };
       }
 
       let mutationError: string | null = null;
@@ -157,15 +159,15 @@ export function registerGroupEndpoints(
 
       if (!updatedDashboard) {
         response.setStatus(404);
-        return { error: 'Dashboard not found' };
+        return { ok: false, error: 'Dashboard not found' };
       }
 
       if (mutationError) {
         response.setStatus(404);
-        return { error: mutationError };
+        return { ok: false, error: mutationError };
       }
 
-      return updatedDashboard;
+      return { ok: true };
     },
   });
 
@@ -174,11 +176,11 @@ export function registerGroupEndpoints(
     path: '/dashboard/remove_dashboard_group',
     description: 'Removes a dashboard group and all widgets inside it. Superadmin only.',
     request_schema: GroupIdRequestSchema,
-    response_schema: DashboardApiResponseSchema,
+    response_schema: DashboardMutationResponseSchema,
     handler: async ({ body, adminUser, response }) => {
       if (!ctx.canEditDashboard(adminUser)) {
         response.setStatus(403);
-        return { error: 'Dashboard edit is not allowed' };
+        return { ok: false, error: 'Dashboard edit is not allowed' };
       }
 
       const groupId = body.groupId;
@@ -200,15 +202,15 @@ export function registerGroupEndpoints(
 
       if (!updatedDashboard) {
         response.setStatus(404);
-        return { error: 'Dashboard not found' };
+        return { ok: false, error: 'Dashboard not found' };
       }
 
       if (mutationError) {
         response.setStatus(404);
-        return { error: mutationError };
+        return { ok: false, error: mutationError };
       }
 
-      return updatedDashboard;
+      return { ok: true };
     },
   });
 

package/endpoint/widgets.ts

@@ -21,7 +21,7 @@ import {
   ConfigurePivotTableWidgetRequestSchema,
   ConfigureStackedBarChartWidgetRequestSchema,
   ConfigureTableWidgetRequestSchema,
-  DashboardApiResponseSchema,
+  DashboardMutationResponseSchema,
   DashboardWidgetDataResponseSchema,
   GroupIdRequestSchema,
   MoveWidgetRequestSchema,
@@ -117,11 +117,11 @@ function registerConfigureWidgetEndpoint(
     path: options.path,
     description: options.description,
     request_schema: options.requestSchema,
-    response_schema: DashboardApiResponseSchema,
+    response_schema: DashboardMutationResponseSchema,
     handler: async ({ body, adminUser, response }) => {
       if (!ctx.canEditDashboard(adminUser)) {
         response.setStatus(403);
-        return { error: 'Dashboard edit is not allowed' };
+        return { ok: false, error: 'Dashboard edit is not allowed' };
       }
 
       const request = body as ConfigureWidgetRequest;
@@ -134,15 +134,15 @@ function registerConfigureWidgetEndpoint(
 
       if (!updatedDashboard) {
         response.setStatus(404);
-        return { error: 'Dashboard not found' };
+        return { ok: false, error: 'Dashboard not found' };
       }
 
       if (mutationError) {
         response.setStatus(404);
-        return { error: mutationError };
+        return { ok: false, error: mutationError };
       }
 
-      return updatedDashboard;
+      return { ok: true };
     },
   });
 }
@@ -156,14 +156,15 @@ export function registerWidgetEndpoints(
     path: '/dashboard/add_dashboard_widget',
     description: 'Adds a new empty widget to a dashboard group. Superadmin only.',
     request_schema: GroupIdRequestSchema,
-    response_schema: DashboardApiResponseSchema,
+    response_schema: DashboardMutationResponseSchema,
     handler: async ({ body, adminUser, response }) => {
       if (!ctx.canEditDashboard(adminUser)) {
         response.setStatus(403);
-        return { error: 'Dashboard edit is not allowed' };
+        return { ok: false, error: 'Dashboard edit is not allowed' };
       }
 
       let mutationError: string | null = null;
+      let widgetId: string | null = null;
       const updatedDashboard = await ctx.updateDashboardConfig(body.slug, (config) => {
         const group = config.groups.find((item) => item.id === body.groupId);
 
@@ -181,6 +182,7 @@ export function registerWidgetEndpoints(
           order: nextOrder,
           target: 'empty',
         };
+        widgetId = widget.id;
 
         return {
           ...config,
@@ -190,15 +192,15 @@ export function registerWidgetEndpoints(
 
       if (!updatedDashboard) {
         response.setStatus(404);
-        return { error: 'Dashboard not found' };
+        return { ok: false, error: 'Dashboard not found' };
       }
 
       if (mutationError) {
         response.setStatus(404);
-        return { error: mutationError };
+        return { ok: false, error: mutationError };
       }
 
-      return updatedDashboard;
+      return { ok: true, widgetId };
     },
   });
 
@@ -207,11 +209,11 @@ export function registerWidgetEndpoints(
     path: '/dashboard/move_dashboard_widget',
     description: 'Moves a dashboard widget up or down inside its group. Superadmin only.',
     request_schema: MoveWidgetRequestSchema,
-    response_schema: DashboardApiResponseSchema,
+    response_schema: DashboardMutationResponseSchema,
     handler: async ({ body, adminUser, response }) => {
       if (!ctx.canEditDashboard(adminUser)) {
         response.setStatus(403);
-        return { error: 'Dashboard edit is not allowed' };
+        return { ok: false, error: 'Dashboard edit is not allowed' };
       }
 
       let mutationError: string | null = null;
@@ -249,15 +251,15 @@ export function registerWidgetEndpoints(
 
       if (!updatedDashboard) {
         response.setStatus(404);
-        return { error: 'Dashboard not found' };
+        return { ok: false, error: 'Dashboard not found' };
       }
 
       if (mutationError) {
         response.setStatus(404);
-        return { error: mutationError };
+        return { ok: false, error: mutationError };
       }
 
-      return updatedDashboard;
+      return { ok: true };
     },
   });
 
@@ -266,11 +268,11 @@ export function registerWidgetEndpoints(
     path: '/dashboard/remove_dashboard_widget',
     description: 'Removes one dashboard widget by id. Superadmin only.',
     request_schema: WidgetIdRequestSchema,
-    response_schema: DashboardApiResponseSchema,
+    response_schema: DashboardMutationResponseSchema,
     handler: async ({ body, adminUser, response }) => {
       if (!ctx.canEditDashboard(adminUser)) {
         response.setStatus(403);
-        return { error: 'Dashboard edit is not allowed' };
+        return { ok: false, error: 'Dashboard edit is not allowed' };
       }
 
       let mutationError: string | null = null;
@@ -290,15 +292,15 @@ export function registerWidgetEndpoints(
 
       if (!updatedDashboard) {
         response.setStatus(404);
-        return { error: 'Dashboard not found' };
+        return { ok: false, error: 'Dashboard not found' };
       }
 
       if (mutationError) {
         response.setStatus(404);
-        return { error: mutationError };
+        return { ok: false, error: mutationError };
       }
 
-      return updatedDashboard;
+      return { ok: true };
     },
   });
 
@@ -308,11 +310,11 @@ export function registerWidgetEndpoints(
     path: '/dashboard/set_widget_config',
     description: 'Replaces editable JSON configuration for a dashboard widget while preserving widget id, group id, and order. Superadmin only.',
     request_schema: SetWidgetConfigRequestSchema,
-    response_schema: DashboardApiResponseSchema,
+    response_schema: DashboardMutationResponseSchema,
     handler: async ({ body, adminUser, response }) => {
       if (!ctx.canEditDashboard(adminUser)) {
         response.setStatus(403);
-        return { error: 'Dashboard edit is not allowed' };
+        return { ok: false, error: 'Dashboard edit is not allowed' };
       }
 
       const request = body as ConfigureWidgetRequest;
@@ -320,15 +322,15 @@ export function registerWidgetEndpoints(
 
       if (!updatedDashboard) {
         response.setStatus(404);
-        return { error: 'Dashboard not found' };
+        return { ok: false, error: 'Dashboard not found' };
       }
 
       if (mutationError) {
         response.setStatus(404);
-        return { error: mutationError };
+        return { ok: false, error: mutationError };
       }
 
-      return updatedDashboard;
+      return { ok: true };
     },
   });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/dashboard",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",

package/schema/api.ts

@@ -203,19 +203,14 @@ export const ConfigureHistogramChartWidgetRequestZodSchema = configureWidgetRequ
 export const ConfigureFunnelChartWidgetRequestZodSchema = configureWidgetRequestSchema(ConfigurableFunnelChartWidgetConfigSchema)
 export const ConfigurePivotTableWidgetRequestZodSchema = configureWidgetRequestSchema(ConfigurablePivotTableWidgetConfigSchema)
 
-export const DashboardMutationResponseZodSchema = z.union([
-  z.object({
-    ok: z.literal(true),
-    slug: z.string(),
-    widgetId: z.string().optional(),
-    groupId: z.string().optional(),
-    target: z.string().optional(),
-    revision: z.number().optional(),
-  }).strict(),
-  DashboardErrorResponseZodSchema,
-])
+export const DashboardMutationResponseZodSchema = z.object({
+  ok: z.boolean(),
+  error: z.string().optional(),
+  groupId: z.string().optional(),
+  widgetId: z.string().optional(),
+}).strict()
 
-export const DashboardApiResponseSchema = toJSONSchema(DashboardApiResponseZodSchema, { target: 'draft-07' })
+export const DashboardApiResponseSchema = toJSONSchema(z.unknown(), { target: 'draft-07' })
 export const DashboardWidgetDataResponseSchema = toJSONSchema(DashboardWidgetDataResponseZodSchema, { target: 'draft-07' })
 export const SlugRequestSchema = toJSONSchema(SlugRequestZodSchema, { target: 'draft-07' })
 export const GroupIdRequestSchema = toJSONSchema(GroupIdRequestZodSchema, { target: 'draft-07' })

package/services/calc-evaluator.ts

@@ -1,5 +1,7 @@
 import { Parser } from 'expr-eval-fork';
+import type { DashboardVariables } from '../custom/model/dashboard.types.js';
 
+const LOOKUP_VARIABLE_PATH_RE = /lookup\(\s*\$variables((?:\.[a-zA-Z_][a-zA-Z0-9_]*)+)\s*,/g;
 const CALC_PARSER_OPTIONS = {
   allowMemberAccess: false,
   operators: {
@@ -14,10 +16,35 @@ const CALC_PARSER_OPTIONS = {
   },
 } as const;
 
-const CALC_PARSER = new Parser(CALC_PARSER_OPTIONS);
+export function evaluateCalc(
+  calc: string,
+  values: Record<string, unknown>,
+  variables: DashboardVariables = {},
+) {
+  const parser = createCalcParser(variables);
 
-export function evaluateCalc(calc: string, values: Record<string, unknown>) {
-  return CALC_PARSER.parse(calc).evaluate(normalizeCalcValues(values));
+  return parser.parse(normalizeLookupPaths(calc)).evaluate(normalizeCalcValues(values));
+}
+
+function createCalcParser(variables: DashboardVariables) {
+  const parser = new Parser(CALC_PARSER_OPTIONS);
+
+  parser.functions.lookup = (path: string | number, key: string | number, defaultValue = 0) => {
+    const map = resolveVariablePath(variables, String(path));
+    const value = isRecord(map) && Object.prototype.hasOwnProperty.call(map, String(key))
+      ? map[String(key)]
+      : defaultValue;
+
+    return toFiniteNumber(value);
+  };
+
+  return parser;
+}
+
+function normalizeLookupPaths(calc: string) {
+  return calc.replace(LOOKUP_VARIABLE_PATH_RE, (_match, path: string) => {
+    return `lookup("${path.replace(/^\./, '')}",`;
+  });
 }
 
 function normalizeCalcValues(values: Record<string, unknown>) {
@@ -31,3 +58,14 @@ function toFiniteNumber(value: unknown) {
   const numberValue = typeof value === 'number' ? value : Number(value);
   return Number.isFinite(numberValue) ? numberValue : 0;
 }
+
+function resolveVariablePath(variables: DashboardVariables, path: string) {
+  return path
+    .split('.')
+    .filter(Boolean)
+    .reduce<unknown>((current, segment) => isRecord(current) ? current[segment] : undefined, variables);
+}
+
+function isRecord(value: unknown): value is Record<string, any> {
+  return typeof value === 'object' && value !== null;
+}

package/services/widgetDataService.ts

@@ -341,7 +341,7 @@ function buildCalculatedRow(
   const values: Record<string, unknown> = { ...baseValues };
 
   for (const item of [...select.filter(isCalcSelectItem), ...calcs]) {
-    values[item.as] = evaluateCalc(item.calc, values);
+    values[item.as] = evaluateCalc(item.calc, values, variables);
   }
 
   return values;
@@ -364,7 +364,7 @@ function buildPlainRow(
   }
 
   for (const item of [...select.filter(isCalcSelectItem), ...calcs]) {
-    values[item.as] = evaluateCalc(item.calc, values);
+    values[item.as] = evaluateCalc(item.calc, values, variables);
   }
 
   return values;