@adminforth/dashboard 1.11.1 → 1.12.0

package/dist/schema/widgets/common.d.ts

@@ -117,6 +117,113 @@ export declare const QueryCalcItemSchema: z.ZodObject<{
     calc: z.ZodString;
     as: z.ZodString;
 }, z.core.$strict>;
+export declare const ResourceQueryConfigSchema: z.ZodObject<{
+    source: z.ZodOptional<z.ZodLiteral<"resource">>;
+    resource: z.ZodString;
+    select: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+        field: z.ZodString;
+        as: z.ZodOptional<z.ZodString>;
+        grain: z.ZodOptional<z.ZodEnum<{
+            day: "day";
+            week: "week";
+            month: "month";
+            year: "year";
+        }>>;
+    }, z.core.$strict>, z.ZodObject<{
+        agg: z.ZodEnum<{
+            sum: "sum";
+            count: "count";
+            count_distinct: "count_distinct";
+            avg: "avg";
+            min: "min";
+            max: "max";
+            median: "median";
+        }>;
+        field: z.ZodOptional<z.ZodString>;
+        as: z.ZodString;
+        filters: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+    }, z.core.$strict>, z.ZodObject<{
+        calc: z.ZodString;
+        as: z.ZodString;
+    }, z.core.$strict>]>>>;
+    sparkline: z.ZodOptional<z.ZodObject<{
+        field: z.ZodString;
+        grain: z.ZodEnum<{
+            day: "day";
+            week: "week";
+            month: "month";
+            year: "year";
+        }>;
+        as: z.ZodString;
+        fill_missing: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strict>>;
+    filters: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+    group_by: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        field: z.ZodString;
+        as: z.ZodOptional<z.ZodString>;
+        grain: z.ZodOptional<z.ZodEnum<{
+            day: "day";
+            week: "week";
+            month: "month";
+            year: "year";
+        }>>;
+        timezone: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>]>>>;
+    order_by: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        field: z.ZodString;
+        direction: z.ZodOptional<z.ZodEnum<{
+            asc: "asc";
+            desc: "desc";
+        }>>;
+    }, z.core.$strict>>>;
+    limit: z.ZodOptional<z.ZodNumber>;
+    offset: z.ZodOptional<z.ZodNumber>;
+    bucket: z.ZodOptional<z.ZodObject<{
+        field: z.ZodString;
+        buckets: z.ZodArray<z.ZodObject<{
+            label: z.ZodString;
+            min: z.ZodOptional<z.ZodNumber>;
+            max: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    calcs: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        calc: z.ZodString;
+        as: z.ZodString;
+    }, z.core.$strict>>>;
+    formatting: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strict>;
+export declare const HistogramResourceQueryConfigSchema: z.ZodObject<{
+    source: z.ZodOptional<z.ZodLiteral<"resource">>;
+    resource: z.ZodString;
+    select: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+        field: z.ZodString;
+        as: z.ZodOptional<z.ZodString>;
+        grain: z.ZodOptional<z.ZodEnum<{
+            day: "day";
+            week: "week";
+            month: "month";
+            year: "year";
+        }>>;
+    }, z.core.$strict>, z.ZodObject<{
+        calc: z.ZodString;
+        as: z.ZodString;
+    }, z.core.$strict>]>>>;
+    filters: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+    order_by: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        field: z.ZodString;
+        direction: z.ZodOptional<z.ZodEnum<{
+            asc: "asc";
+            desc: "desc";
+        }>>;
+    }, z.core.$strict>>>;
+    limit: z.ZodOptional<z.ZodNumber>;
+    offset: z.ZodOptional<z.ZodNumber>;
+    calcs: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        calc: z.ZodString;
+        as: z.ZodString;
+    }, z.core.$strict>>>;
+    formatting: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strict>;
 export declare const QueryConfigSchema: z.ZodUnion<readonly [z.ZodObject<{
     source: z.ZodOptional<z.ZodLiteral<"resource">>;
     resource: z.ZodString;
@@ -212,6 +319,14 @@ export declare const QueryConfigSchema: z.ZodUnion<readonly [z.ZodObject<{
         }, z.core.$strict>>;
         filters: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
     }, z.core.$strict>>;
+    bucket: z.ZodOptional<z.ZodObject<{
+        field: z.ZodString;
+        buckets: z.ZodArray<z.ZodObject<{
+            label: z.ZodString;
+            min: z.ZodOptional<z.ZodNumber>;
+            max: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
     calcs: z.ZodOptional<z.ZodArray<z.ZodObject<{
         calc: z.ZodString;
         as: z.ZodString;

package/dist/schema/widgets/common.js

@@ -123,7 +123,7 @@ export const QueryCalcItemSchema = z.object({
     calc: z.string(),
     as: z.string(),
 }).strict();
-const ResourceQueryConfigSchema = z.object({
+export const ResourceQueryConfigSchema = z.object({
     source: z.literal('resource').optional(),
     resource: z.string(),
     select: z.array(QuerySelectItemSchema).optional(),
@@ -142,6 +142,21 @@ const ResourceQueryConfigSchema = z.object({
     calcs: z.array(QueryCalcItemSchema).optional(),
     formatting: z.record(z.string(), z.unknown()).optional(),
 }).strict();
+const HistogramQuerySelectItemSchema = z.union([
+    QueryFieldSelectItemSchema,
+    QueryCalcSelectItemSchema,
+]);
+export const HistogramResourceQueryConfigSchema = z.object({
+    source: z.literal('resource').optional(),
+    resource: z.string(),
+    select: z.array(HistogramQuerySelectItemSchema).optional(),
+    filters: FilterExpressionSchema.optional(),
+    order_by: z.array(QueryOrderByItemSchema).optional(),
+    limit: z.number().int().positive().optional(),
+    offset: z.number().int().nonnegative().optional(),
+    calcs: z.array(QueryCalcItemSchema).optional(),
+    formatting: z.record(z.string(), z.unknown()).optional(),
+}).strict();
 const StepsQuerySelectStepSchema = z.object({
     name: z.string(),
     resource: z.string(),
@@ -153,6 +168,7 @@ export const QueryConfigSchema = z.union([
     z.object({
         source: z.literal('steps'),
         steps: z.array(StepsQuerySelectStepSchema).min(1),
+        bucket: BucketConfigSchema.optional(),
         calcs: z.array(QueryCalcItemSchema).optional(),
         order_by: z.array(QueryOrderByItemSchema).optional(),
         limit: z.number().int().positive().optional(),

package/dist/schema/widgets/gauge-card.d.ts

@@ -190,6 +190,14 @@ export declare const GaugeCardWidgetConfigSchema: z.ZodObject<{
             }, z.core.$strict>>;
             filters: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
         }, z.core.$strict>>;
+        bucket: z.ZodOptional<z.ZodObject<{
+            field: z.ZodString;
+            buckets: z.ZodArray<z.ZodObject<{
+                label: z.ZodString;
+                min: z.ZodOptional<z.ZodNumber>;
+                max: z.ZodOptional<z.ZodNumber>;
+            }, z.core.$strict>>;
+        }, z.core.$strict>>;
         calcs: z.ZodOptional<z.ZodArray<z.ZodObject<{
             calc: z.ZodString;
             as: z.ZodString;

package/dist/schema/widgets/kpi-card.d.ts

@@ -230,6 +230,14 @@ export declare const KpiCardWidgetConfigSchema: z.ZodObject<{
             }, z.core.$strict>>;
             filters: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
         }, z.core.$strict>>;
+        bucket: z.ZodOptional<z.ZodObject<{
+            field: z.ZodString;
+            buckets: z.ZodArray<z.ZodObject<{
+                label: z.ZodString;
+                min: z.ZodOptional<z.ZodNumber>;
+                max: z.ZodOptional<z.ZodNumber>;
+            }, z.core.$strict>>;
+        }, z.core.$strict>>;
         calcs: z.ZodOptional<z.ZodArray<z.ZodObject<{
             calc: z.ZodString;
             as: z.ZodString;

package/dist/schema/widgets/pivot-table.d.ts

@@ -214,6 +214,14 @@ export declare const PivotTableWidgetConfigSchema: z.ZodObject<{
             }, z.core.$strict>>;
             filters: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
         }, z.core.$strict>>;
+        bucket: z.ZodOptional<z.ZodObject<{
+            field: z.ZodString;
+            buckets: z.ZodArray<z.ZodObject<{
+                label: z.ZodString;
+                min: z.ZodOptional<z.ZodNumber>;
+                max: z.ZodOptional<z.ZodNumber>;
+            }, z.core.$strict>>;
+        }, z.core.$strict>>;
         calcs: z.ZodOptional<z.ZodArray<z.ZodObject<{
             calc: z.ZodString;
             as: z.ZodString;

package/dist/schema/widgets/table.d.ts

@@ -148,6 +148,14 @@ export declare const TableWidgetConfigSchema: z.ZodObject<{
             }, z.core.$strict>>;
             filters: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
         }, z.core.$strict>>;
+        bucket: z.ZodOptional<z.ZodObject<{
+            field: z.ZodString;
+            buckets: z.ZodArray<z.ZodObject<{
+                label: z.ZodString;
+                min: z.ZodOptional<z.ZodNumber>;
+                max: z.ZodOptional<z.ZodNumber>;
+            }, z.core.$strict>>;
+        }, z.core.$strict>>;
         calcs: z.ZodOptional<z.ZodArray<z.ZodObject<{
             calc: z.ZodString;
             as: z.ZodString;

package/dist/services/widgetDataService.js

@@ -63,6 +63,9 @@ function getQueryWidgetData(adminforth, query, variables) {
 function getStepsQueryData(adminforth, query, variables) {
     return __awaiter(this, void 0, void 0, function* () {
         var _a, _b, _c, _d;
+        if (query.bucket) {
+            return getBucketedStepsQueryData(adminforth, query, query.bucket, variables);
+        }
         const rows = yield Promise.all(query.steps.map((step) => __awaiter(this, void 0, void 0, function* () {
             const select = getStepSelect(step);
             const [values = {}] = yield getAggregateRows(adminforth, step.resource, step.filters, select, []);
@@ -86,6 +89,35 @@ function getStepsQueryData(adminforth, query, variables) {
         };
     });
 }
+function getBucketedStepsQueryData(adminforth, query, bucketConfig, variables) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, _b, _c, _d;
+        const rows = (yield Promise.all(query.steps.map((step) => __awaiter(this, void 0, void 0, function* () {
+            const select = getStepSelect(step);
+            const stepRows = yield Promise.all(bucketConfig.buckets.map((bucket) => __awaiter(this, void 0, void 0, function* () {
+                const [values = {}] = yield getAggregateRows(adminforth, step.resource, mergeFilters(step.filters, getBucketFilter(bucketConfig, bucket)), select, []);
+                return buildCalculatedRow(Object.assign({ label: bucket.label, name: step.name, resource: step.resource }, values), select, query.calcs, variables);
+            })));
+            return stepRows;
+        })))).flat();
+        const orderedRows = sortRows(rows, query.order_by);
+        const slicedRows = typeof query.limit === 'number'
+            ? orderedRows.slice((_a = query.offset) !== null && _a !== void 0 ? _a : 0, ((_b = query.offset) !== null && _b !== void 0 ? _b : 0) + query.limit)
+            : orderedRows.slice((_c = query.offset) !== null && _c !== void 0 ? _c : 0);
+        const columns = Array.from(new Set([
+            'label',
+            'name',
+            'resource',
+            ...query.steps.flatMap((step) => getStepSelect(step).map((item) => item.as)),
+            ...((_d = query.calcs) !== null && _d !== void 0 ? _d : []).map((item) => item.as),
+        ]));
+        return {
+            kind: 'aggregate',
+            columns,
+            rows: slicedRows,
+        };
+    });
+}
 function getSingleAggregateWidgetData(adminforth, query, aggregate) {
     return __awaiter(this, void 0, void 0, function* () {
         var _a;
@@ -256,6 +288,16 @@ function getSingleAggregateSelectItem(query) {
 function isStepsQuery(query) {
     return query.source === 'steps';
 }
+function getBucketFilter(bucketConfig, bucket) {
+    const filters = [];
+    if (typeof bucket.min === 'number') {
+        filters.push({ field: bucketConfig.field, gte: bucket.min });
+    }
+    if (typeof bucket.max === 'number') {
+        filters.push({ field: bucketConfig.field, lt: bucket.max });
+    }
+    return filters.length ? { and: filters } : undefined;
+}
 function getStepSelect(step) {
     return step.select;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/dashboard",
-  "version": "1.11.1",
+  "version": "1.12.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
@@ -21,7 +21,7 @@
   "description": "Dashboard plugin for AdminForth",
   "devDependencies": {
     "@types/node": "latest",
-    "adminforth": "2.61.0-next.9",
+    "adminforth": "2.71.0",
     "semantic-release": "^24.2.1",
     "semantic-release-slack-bot": "^4.0.2",
     "typescript": "^5.7.3",

package/schema/api.ts

@@ -3,6 +3,7 @@ import {
   BarChartSchema,
   FunnelChartSchema,
   GaugeCardViewConfigSchema,
+  HistogramResourceQueryConfigSchema,
   HistogramChartSchema,
   KpiCardViewConfigSchema,
   LineChartSchema,
@@ -151,7 +152,7 @@ const ConfigurablePieChartWidgetConfigSchema = WidgetEditableBaseSchema.extend({
 const ConfigurableHistogramChartWidgetConfigSchema = WidgetEditableBaseSchema.extend({
   target: z.literal('chart'),
   chart: HistogramChartSchema,
-  query: QueryConfigSchema,
+  query: HistogramResourceQueryConfigSchema,
 })
 
 const ConfigurableFunnelChartWidgetConfigSchema = WidgetEditableBaseSchema.extend({

package/schema/widget.ts

@@ -33,7 +33,9 @@ export {
 } from './widgets/table.js'
 export {
   EmptyWidgetConfigSchema,
+  HistogramResourceQueryConfigSchema,
   QueryConfigSchema,
+  ResourceQueryConfigSchema,
   WidgetEditableBaseSchema,
 } from './widgets/common.js'
 import { ChartWidgetTargetConfigSchema } from './widgets/charts.js'

package/schema/widgets/charts.ts

@@ -1,6 +1,7 @@
 import { z } from 'zod'
 import {
   ChartFieldRefSchema,
+  HistogramResourceQueryConfigSchema,
   QueryConfigSchema,
   WidgetBaseSchema,
 } from './common.js'
@@ -93,7 +94,7 @@ export const PieChartWidgetConfigSchema = WidgetBaseSchema.extend({
 export const HistogramChartWidgetConfigSchema = WidgetBaseSchema.extend({
   target: z.literal('chart'),
   chart: HistogramChartSchema,
-  query: QueryConfigSchema,
+  query: HistogramResourceQueryConfigSchema,
 })
 
 export const FunnelChartWidgetConfigSchema = WidgetBaseSchema.extend({

package/schema/widgets/common.ts

@@ -140,7 +140,7 @@ export const QueryCalcItemSchema = z.object({
   as: z.string(),
 }).strict()
 
-const ResourceQueryConfigSchema = z.object({
+export const ResourceQueryConfigSchema = z.object({
   source: z.literal('resource').optional(),
   resource: z.string(),
   select: z.array(QuerySelectItemSchema).optional(),
@@ -160,6 +160,23 @@ const ResourceQueryConfigSchema = z.object({
   formatting: z.record(z.string(), z.unknown()).optional(),
 }).strict()
 
+const HistogramQuerySelectItemSchema = z.union([
+  QueryFieldSelectItemSchema,
+  QueryCalcSelectItemSchema,
+])
+
+export const HistogramResourceQueryConfigSchema = z.object({
+  source: z.literal('resource').optional(),
+  resource: z.string(),
+  select: z.array(HistogramQuerySelectItemSchema).optional(),
+  filters: FilterExpressionSchema.optional(),
+  order_by: z.array(QueryOrderByItemSchema).optional(),
+  limit: z.number().int().positive().optional(),
+  offset: z.number().int().nonnegative().optional(),
+  calcs: z.array(QueryCalcItemSchema).optional(),
+  formatting: z.record(z.string(), z.unknown()).optional(),
+}).strict()
+
 const StepsQuerySelectStepSchema = z.object({
   name: z.string(),
   resource: z.string(),
@@ -172,6 +189,7 @@ export const QueryConfigSchema = z.union([
   z.object({
     source: z.literal('steps'),
     steps: z.array(StepsQuerySelectStepSchema).min(1),
+    bucket: BucketConfigSchema.optional(),
     calcs: z.array(QueryCalcItemSchema).optional(),
     order_by: z.array(QueryOrderByItemSchema).optional(),
     limit: z.number().int().positive().optional(),

package/services/widgetDataService.ts

@@ -10,6 +10,7 @@ import type {
   FilterExpression,
   QueryAggregateSelectItem,
   QueryCalcSelectItem,
+  QueryBucketConfig,
   QueryConfig,
   QueryFieldSelectItem,
   QueryGroupByItem,
@@ -153,6 +154,10 @@ async function getStepsQueryData(
   query: Extract<QueryConfig, { source: 'steps' }>,
   variables: DashboardVariables,
 ): Promise<DashboardWidgetData> {
+  if (query.bucket) {
+    return getBucketedStepsQueryData(adminforth, query, query.bucket, variables);
+  }
+
   const rows = await Promise.all(query.steps.map(async (step) => {
     const select = getStepSelect(step);
     const [values = {}] = await getAggregateRows(
@@ -188,6 +193,52 @@ async function getStepsQueryData(
   };
 }
 
+async function getBucketedStepsQueryData(
+  adminforth: IAdminForth,
+  query: Extract<QueryConfig, { source: 'steps' }>,
+  bucketConfig: QueryBucketConfig,
+  variables: DashboardVariables,
+): Promise<DashboardWidgetData> {
+  const rows = (await Promise.all(query.steps.map(async (step) => {
+    const select = getStepSelect(step);
+    const stepRows = await Promise.all(bucketConfig.buckets.map(async (bucket) => {
+      const [values = {}] = await getAggregateRows(
+        adminforth,
+        step.resource,
+        mergeFilters(step.filters, getBucketFilter(bucketConfig, bucket)),
+        select,
+        [],
+      );
+
+      return buildCalculatedRow({
+        label: bucket.label,
+        name: step.name,
+        resource: step.resource,
+        ...values,
+      }, select, query.calcs, variables);
+    }));
+
+    return stepRows;
+  }))).flat();
+  const orderedRows = sortRows(rows, query.order_by);
+  const slicedRows = typeof query.limit === 'number'
+    ? orderedRows.slice(query.offset ?? 0, (query.offset ?? 0) + query.limit)
+    : orderedRows.slice(query.offset ?? 0);
+  const columns = Array.from(new Set([
+    'label',
+    'name',
+    'resource',
+    ...query.steps.flatMap((step) => getStepSelect(step).map((item) => item.as)),
+    ...(query.calcs ?? []).map((item) => item.as),
+  ]));
+
+  return {
+    kind: 'aggregate',
+    columns,
+    rows: slicedRows,
+  };
+}
+
 async function getSingleAggregateWidgetData(
   adminforth: IAdminForth,
   query: ResourceQueryConfig,
@@ -447,6 +498,23 @@ function isStepsQuery(query: QueryConfig): query is Extract<QueryConfig, { sourc
   return query.source === 'steps';
 }
 
+function getBucketFilter(
+  bucketConfig: QueryBucketConfig,
+  bucket: QueryBucketConfig['buckets'][number],
+): FilterExpression | undefined {
+  const filters: FilterExpression[] = [];
+
+  if (typeof bucket.min === 'number') {
+    filters.push({ field: bucketConfig.field, gte: bucket.min });
+  }
+
+  if (typeof bucket.max === 'number') {
+    filters.push({ field: bucketConfig.field, lt: bucket.max });
+  }
+
+  return filters.length ? { and: filters } : undefined;
+}
+
 function getStepSelect(step: StepsQueryStepConfig): QueryAggregateSelectItem[] {
   return step.select;
 }