@adminforth/dashboard 1.2.0 → 1.4.0

package/dist/custom/widgets/chart/line/LineChart.vue

@@ -85,7 +85,14 @@
 <script setup lang="ts">
 import { computed } from 'vue'
 import { useElementSize } from '../../../composables/useElementSize.js'
-import { CHART_COLORS, formatChartAxisLabel, formatChartLabel, formatChartValue, toFiniteNumber } from '../chart.utils.js'
+import {
+  CHART_COLORS,
+  formatChartAxisLabel,
+  formatChartLabel,
+  formatChartValue,
+  getChartYAxisWidth,
+  toFiniteNumber,
+} from '../chart.utils.js'
 
 const props = withDefaults(defineProps<{
   rows: Record<string, unknown>[]
@@ -100,12 +107,6 @@ const props = withDefaults(defineProps<{
 
 const { el: rootEl, width: rootWidth, height: rootHeight } = useElementSize<HTMLDivElement>()
 
-const padding = {
-  top: 12,
-  right: 6,
-  bottom: 24,
-  left: 38,
-}
 const chartWidth = computed(() => Math.max(rootWidth.value, 1))
 const chartHeight = computed(() => {
   if (rootHeight.value > 0) {
@@ -118,14 +119,21 @@ const chartHeight = computed(() => {
 const chartColor = computed(() => props.color || CHART_COLORS[0])
 const values = computed(() => props.rows.map((row) => toFiniteNumber(row[props.yField])))
 const maxValue = computed(() => Math.max(...values.value, 1))
-const innerWidth = computed(() => Math.max(chartWidth.value - padding.left - padding.right, 1))
-const innerHeight = computed(() => Math.max(chartHeight.value - padding.top - padding.bottom, 1))
+const yTickValues = computed(() => [maxValue.value, maxValue.value * 0.5, 0])
+const padding = computed(() => ({
+  top: 12,
+  right: 6,
+  bottom: 24,
+  left: getChartYAxisWidth(yTickValues.value, chartWidth.value),
+}))
+const innerWidth = computed(() => Math.max(chartWidth.value - padding.value.left - padding.value.right, 1))
+const innerHeight = computed(() => Math.max(chartHeight.value - padding.value.top - padding.value.bottom, 1))
 
 const points = computed(() => {
   if (props.rows.length === 1) {
     return [{
-      x: padding.left + innerWidth.value / 2,
-      y: padding.top + innerHeight.value - (values.value[0] / maxValue.value) * innerHeight.value,
+      x: padding.value.left + innerWidth.value / 2,
+      y: padding.value.top + innerHeight.value - (values.value[0] / maxValue.value) * innerHeight.value,
       label: formatChartLabel(props.rows[0][props.xField]),
       axisLabel: formatChartAxisLabel(props.rows[0][props.xField]),
       value: values.value[0],
@@ -133,8 +141,8 @@ const points = computed(() => {
   }
 
   return props.rows.map((row, index) => ({
-    x: padding.left + (index / (props.rows.length - 1)) * innerWidth.value,
-    y: padding.top + innerHeight.value - (values.value[index] / maxValue.value) * innerHeight.value,
+    x: padding.value.left + (index / (props.rows.length - 1)) * innerWidth.value,
+    y: padding.value.top + innerHeight.value - (values.value[index] / maxValue.value) * innerHeight.value,
     label: formatChartLabel(row[props.xField]),
     axisLabel: formatChartAxisLabel(row[props.xField]),
     value: values.value[index],
@@ -152,12 +160,12 @@ const fillPath = computed(() => {
 
   const first = points.value[0]
   const last = points.value[points.value.length - 1]
-  return `${linePath.value} L ${last.x} ${padding.top + innerHeight.value} L ${first.x} ${padding.top + innerHeight.value} Z`
+  return `${linePath.value} L ${last.x} ${padding.value.top + innerHeight.value} L ${first.x} ${padding.value.top + innerHeight.value} Z`
 })
 
 const yTicks = computed(() => [0, 0.5, 1].map((ratio) => ({
   value: maxValue.value * (1 - ratio),
-  y: padding.top + innerHeight.value * ratio,
+  y: padding.value.top + innerHeight.value * ratio,
 })))
 
 const xLabels = computed(() => {

package/dist/custom/widgets/chart/stacked-bar/StackedBarChart.vue

@@ -1,13 +1,20 @@
 <script setup lang="ts">
 import { computed } from 'vue'
 import { useElementSize } from '../../../composables/useElementSize.js'
-import type { ChartWidgetSeriesConfig } from '../chart.types.js'
-import { CHART_COLORS, formatChartAxisLabel, formatChartLabel, formatChartValue, toFiniteNumber } from '../chart.utils.js'
+import {
+  CHART_COLORS,
+  formatChartAxisLabel,
+  formatChartLabel,
+  formatChartValue,
+  getChartYAxisWidth,
+  toFiniteNumber,
+} from '../chart.utils.js'
 
 const props = withDefaults(defineProps<{
   rows: Record<string, unknown>[]
   xField: string
-  series: ChartWidgetSeriesConfig[]
+  yField: string
+  seriesField: string
   colors?: string[]
   height?: number
 }>(), {
@@ -17,16 +24,11 @@ const props = withDefaults(defineProps<{
 const { el: rootEl, width: rootWidth } = useElementSize<HTMLDivElement>()
 const { el: svgEl, width: svgWidth, height: svgHeight } = useElementSize<HTMLDivElement>()
 
-const padding = {
-  top: 24,
-  right: 6,
-  bottom: 34,
-  left: 38,
-}
 const barGap = 10
-const normalizedSeries = computed(() => props.series.map((series, index) => ({
-  ...series,
-  color: series.color || props.colors?.[index] || CHART_COLORS[index % CHART_COLORS.length],
+const seriesNames = computed(() => Array.from(new Set(props.rows.map((row) => formatChartLabel(row[props.seriesField])))))
+const normalizedSeries = computed(() => seriesNames.value.map((name, index) => ({
+  name,
+  color: props.colors?.[index] || CHART_COLORS[index % CHART_COLORS.length],
 })))
 const showLegend = computed(() => normalizedSeries.value.length > 0)
 const isCompact = computed(() => rootWidth.value > 0 && rootWidth.value < 420)
@@ -38,19 +40,15 @@ const chartHeight = computed(() => {
 
   return Math.max(props.height - (showLegend.value ? 28 : 0), 96)
 })
-const innerWidth = computed(() => Math.max(chartWidth.value - padding.left - padding.right, 1))
-const innerHeight = computed(() => Math.max(chartHeight.value - padding.top - padding.bottom, 1))
 const groupedRows = computed(() => {
   const grouped = new Map<string, Record<string, unknown>>()
 
   for (const row of props.rows) {
     const label = formatChartLabel(row[props.xField])
     const item = grouped.get(label) ?? { [props.xField]: label }
+    const seriesName = formatChartLabel(row[props.seriesField])
 
-    for (const series of normalizedSeries.value) {
-      item[series.name] = toFiniteNumber(item[series.name])
-        + getSeriesContribution(row[series.field], series.name)
-    }
+    item[seriesName] = toFiniteNumber(item[seriesName]) + toFiniteNumber(row[props.yField])
 
     grouped.set(label, item)
   }
@@ -65,15 +63,24 @@ const totalChartWidth = computed(() => {
   const count = Math.max(groupedRows.value.length, 1)
   return count * barWidth.value + (count - 1) * barGap
 })
-const chartStartX = computed(() => padding.left + Math.max((innerWidth.value - totalChartWidth.value) / 2, 0))
+const chartStartX = computed(() => padding.value.left + Math.max((innerWidth.value - totalChartWidth.value) / 2, 0))
 const totals = computed(() => groupedRows.value.map((row) => normalizedSeries.value.reduce(
   (sum, series) => sum + toFiniteNumber(row[series.name]),
   0,
 )))
 const maxTotal = computed(() => Math.max(...totals.value, 1))
+const yTickValues = computed(() => [maxTotal.value, maxTotal.value * 0.5, 0])
+const padding = computed(() => ({
+  top: 24,
+  right: 6,
+  bottom: 34,
+  left: getChartYAxisWidth(yTickValues.value, chartWidth.value),
+}))
+const innerWidth = computed(() => Math.max(chartWidth.value - padding.value.left - padding.value.right, 1))
+const innerHeight = computed(() => Math.max(chartHeight.value - padding.value.top - padding.value.bottom, 1))
 
 const bars = computed(() => groupedRows.value.map((row, rowIndex) => {
-  let y = padding.top + innerHeight.value
+  let y = padding.value.top + innerHeight.value
 
   return {
     label: String(row[props.xField]),
@@ -118,31 +125,9 @@ const visibleLabelIndexes = computed(() => {
 
 const yTicks = computed(() => [0, 0.5, 1].map((ratio) => ({
   value: maxTotal.value * (1 - ratio),
-  y: padding.top + innerHeight.value * ratio,
+  y: padding.value.top + innerHeight.value * ratio,
 })))
 
-function getSeriesContribution(value: unknown, seriesName: string) {
-  if (typeof value === 'boolean') {
-    return value === getBooleanSeriesValue(seriesName) ? 1 : 0
-  }
-
-  if (typeof value === 'string' && ['true', 'false'].includes(value.toLowerCase())) {
-    return (value.toLowerCase() === 'true') === getBooleanSeriesValue(seriesName) ? 1 : 0
-  }
-
-  return toFiniteNumber(value)
-}
-
-function getBooleanSeriesValue(seriesName: string) {
-  const normalizedName = seriesName.toLowerCase()
-
-  if (normalizedName.includes('unlisted') || normalizedName.includes('false')) {
-    return false
-  }
-
-  return true
-}
-
 function getBarTooltip(bar: { label: string, total: number, segments: Array<{ name: string, value: number }> }) {
   const percentFormatter = new Intl.NumberFormat(undefined, { maximumFractionDigits: 1 })
 

package/dist/custom/widgets/gauge-card/GaugeCardWidget.vue

@@ -1,9 +1,6 @@
 <script setup lang="ts">
 import { computed, watch } from 'vue'
 import { useWidgetData } from '../../queries/useWidgetData.js'
-import {
-  normalizeGaugeCardWidgetConfig,
-} from '../../model/dashboard.types.js'
 import type { DashboardWidgetConfig, DashboardWidgetTableData } from '../../model/dashboard.types.js'
 import { CHART_COLORS, formatChartValue, toFiniteNumber } from '../chart/chart.utils.js'
 
@@ -55,20 +52,18 @@ watch(
   { deep: true },
 )
 
-const gaugeConfig = computed(() => normalizeGaugeCardWidgetConfig(props.widget.gauge_card))
+const gaugeConfig = computed(() => props.widget.target === 'gauge_card' ? props.widget.card : undefined)
 const widgetData = computed(() => data.value?.data as DashboardWidgetTableData | null)
 const columns = computed(() => widgetData.value?.columns ?? [])
 const firstRow = computed(() => widgetData.value?.rows[0] ?? {})
-const valueField = computed(() => gaugeConfig.value?.valueField || columns.value[0])
-const minField = computed(() => gaugeConfig.value?.minField)
-const maxField = computed(() => gaugeConfig.value?.maxField)
+const valueField = computed(() => gaugeConfig.value?.value.field || columns.value[0])
+const targetField = computed(() => gaugeConfig.value?.target?.field ?? gaugeConfig.value?.progress?.targetField)
 const minValue = computed(() => {
-  const dynamicMin = minField.value ? parseOptionalNumber(firstRow.value[minField.value]) : undefined
-  return dynamicMin ?? parseOptionalNumber(gaugeConfig.value?.min) ?? 0
+  return 0
 })
 const maxValue = computed(() => {
-  const dynamicMax = maxField.value ? parseOptionalNumber(firstRow.value[maxField.value]) : undefined
-  return dynamicMax ?? parseOptionalNumber(gaugeConfig.value?.max) ?? 100
+  const dynamicMax = targetField.value ? parseOptionalNumber(firstRow.value[targetField.value]) : undefined
+  return dynamicMax ?? parseOptionalNumber(gaugeConfig.value?.target?.value ?? gaugeConfig.value?.progress?.targetValue) ?? 100
 })
 const value = computed(() => toFiniteNumber(firstRow.value[valueField.value]))
 const fractionDigits = computed(() => Math.min([
@@ -148,7 +143,7 @@ const gaugeColor = computed(() => gaugeConfig.value?.color || CHART_COLORS[0])
       </svg>
 
       <div class="text-3xl font-bold text-lightNavbarText dark:text-darkNavbarText">
-        {{ formattedValue }}{{ gaugeConfig?.suffix ?? '' }}
+        {{ gaugeConfig?.value.prefix ?? '' }}{{ formattedValue }}{{ gaugeConfig?.value.suffix ?? '' }}
       </div>
       <div class="text-sm text-lightListTableText dark:text-darkListTableText">
         {{ formattedMinValue }} - {{ formattedMaxValue }}

package/dist/custom/widgets/kpi-card/KpiCardWidget.vue

@@ -1,9 +1,6 @@
 <script setup lang="ts">
 import { computed, watch } from 'vue'
 import { useWidgetData } from '../../queries/useWidgetData.js'
-import {
-  normalizeKpiCardWidgetConfig,
-} from '../../model/dashboard.types.js'
 import type { DashboardWidgetConfig, DashboardWidgetTableData } from '../../model/dashboard.types.js'
 import { formatChartValue, toFiniteNumber } from '../chart/chart.utils.js'
 
@@ -29,15 +26,16 @@ watch(
   { deep: true },
 )
 
-const kpiConfig = computed(() => normalizeKpiCardWidgetConfig(props.widget.kpi_card))
+const kpiConfig = computed(() => props.widget.target === 'kpi_card' ? props.widget.card : undefined)
 const widgetData = computed(() => data.value?.data as DashboardWidgetTableData | null)
 const columns = computed(() => widgetData.value?.columns ?? [])
 const firstRow = computed(() => widgetData.value?.rows[0] ?? {})
-const valueField = computed(() => kpiConfig.value?.valueField || columns.value[0])
-const labelField = computed(() => kpiConfig.value?.labelField)
+const valueField = computed(() => kpiConfig.value?.value.field || columns.value[0])
 const value = computed(() => toFiniteNumber(firstRow.value[valueField.value]))
-const label = computed(() => labelField.value ? String(firstRow.value[labelField.value]) : props.widget.label)
-const formattedValue = computed(() => `${kpiConfig.value?.prefix ?? ''}${formatChartValue(value.value)}${kpiConfig.value?.suffix ?? ''}`)
+const label = computed(() => kpiConfig.value?.subtitle?.field
+  ? String(firstRow.value[kpiConfig.value.subtitle.field])
+  : kpiConfig.value?.subtitle?.text ?? kpiConfig.value?.title ?? props.widget.label)
+const formattedValue = computed(() => `${kpiConfig.value?.value.prefix ?? ''}${formatChartValue(value.value)}${kpiConfig.value?.value.suffix ?? ''}`)
 </script>
 
 <template>

package/dist/custom/widgets/pivot-table/PivotTableWidget.vue

@@ -2,7 +2,7 @@
 import { computed, watch } from 'vue'
 import { useWidgetData } from '../../queries/useWidgetData.js'
 import {
-  normalizePivotTableWidgetConfig,
+  getFieldRefField,
 } from '../../model/dashboard.types.js'
 import type { DashboardWidgetConfig, DashboardWidgetData } from '../../model/dashboard.types.js'
 import { formatChartLabel, formatChartValue, toFiniteNumber } from '../chart/chart.utils.js'
@@ -29,16 +29,17 @@ watch(
   { deep: true },
 )
 
-const pivotConfig = computed(() => normalizePivotTableWidgetConfig(props.widget.pivot_table))
+const pivotConfig = computed(() => props.widget.target === 'pivot_table' ? props.widget.pivot : undefined)
 const widgetData = computed(() => data.value?.data as DashboardWidgetData | null)
 const rows = computed(() => widgetData.value?.rows ?? [])
 const columns = computed(() => widgetData.value?.columns ?? [])
 const isAggregateData = computed(() => widgetData.value?.kind === 'aggregate')
-const shouldRenderAggregateMatrix = computed(() => isAggregateData.value && !pivotConfig.value?.columnField)
-const rowField = computed(() => pivotConfig.value?.rowField || (isAggregateData.value ? 'group' : columns.value[0]))
-const columnField = computed(() => pivotConfig.value?.columnField || columns.value[1])
-const valueField = computed(() => pivotConfig.value?.valueField || columns.value[2] || columns.value[1])
-const aggregation = computed(() => pivotConfig.value?.aggregation || (valueField.value ? 'sum' : 'count'))
+const shouldRenderAggregateMatrix = computed(() => isAggregateData.value && !pivotConfig.value?.columns?.length)
+const rowField = computed(() => getFieldRefField(pivotConfig.value?.rows[0]) || columns.value[0])
+const columnField = computed(() => getFieldRefField(pivotConfig.value?.columns?.[0]) || columns.value[1])
+const valueConfig = computed(() => pivotConfig.value?.values[0])
+const valueField = computed(() => valueConfig.value?.field || columns.value[2] || columns.value[1])
+const aggregation = computed(() => valueConfig.value?.aggregation || (valueField.value ? 'sum' : 'count'))
 const pivotColumnLabels = computed(() => {
   if (shouldRenderAggregateMatrix.value) {
     return columns.value.filter((column) => column !== rowField.value)

package/dist/custom/widgets/table/TableWidget.vue

@@ -113,10 +113,11 @@
 <script setup lang="ts">
 import { computed, ref, watch } from 'vue'
 import { useWidgetData } from '../../queries/useWidgetData.js'
-import type { DashboardWidgetConfig, DashboardWidgetTableData } from '../../model/dashboard.types.js'
+import { getFieldRefField } from '../../model/dashboard.types.js'
+import type { DashboardWidgetConfig, DashboardWidgetTableData, FieldRef } from '../../model/dashboard.types.js'
 
 type TableWidgetConfig = {
-  columns?: string[]
+  columns?: FieldRef[]
   pagination?: boolean
   pageSize?: number
 }
@@ -168,7 +169,11 @@ const tableData = computed(() => {
 
 const columns = computed(() => {
   const configuredColumns = tableConfig.value?.columns
-  return configuredColumns ?? tableData.value?.columns ?? []
+  if (configuredColumns) {
+    return configuredColumns.map((column) => getFieldRefField(column)).filter(Boolean) as string[]
+  }
+
+  return tableData.value?.columns ?? []
 })
 
 const pagination = computed(() => tableData.value?.pagination)

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

@@ -24,10 +24,13 @@ function formatWidgetConfigFieldPath(field) {
     const fieldAliases = new Map([
         ['minWidth', 'min_width'],
         ['maxWidth', 'max_width'],
-        ['dataSource', 'data_source'],
-        ['resourceId', 'resource_id'],
         ['groupBy', 'group_by'],
+        ['orderBy', 'order_by'],
         ['pageSize', 'page_size'],
+        ['timeSeries', 'time_series'],
+        ['valueField', 'value_field'],
+        ['targetValue', 'target_value'],
+        ['targetField', 'target_field'],
     ]);
     return field
         .split('.')
@@ -210,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,
                 }),
             };
         }),