@adminforth/dashboard 1.7.0 → 1.9.0

package/dist/schema/widgets/charts.js

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { ChartFieldRefSchema, FunnelQueryConfigSchema, QueryConfigSchema, WidgetBaseSchema, } from './common.js';
+import { ChartFieldRefSchema, QueryConfigSchema, WidgetBaseSchema, } from './common.js';
 const ChartBaseSchema = z.object({
     title: z.string().optional(),
 }).strict();
@@ -80,7 +80,7 @@ export const HistogramChartWidgetConfigSchema = WidgetBaseSchema.extend({
 export const FunnelChartWidgetConfigSchema = WidgetBaseSchema.extend({
     target: z.literal('chart'),
     chart: FunnelChartSchema,
-    query: FunnelQueryConfigSchema,
+    query: QueryConfigSchema,
 });
 export const ChartWidgetTargetConfigSchema = z.union([
     LineChartWidgetConfigSchema,

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

@@ -117,7 +117,8 @@ export declare const QueryCalcItemSchema: z.ZodObject<{
     calc: z.ZodString;
     as: z.ZodString;
 }, z.core.$strict>;
-export declare const QueryConfigSchema: z.ZodObject<{
+export declare const QueryConfigSchema: z.ZodUnion<readonly [z.ZodObject<{
+    source: z.ZodOptional<z.ZodLiteral<"resource">>;
     resource: z.ZodString;
     select: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
         field: z.ZodString;
@@ -190,12 +191,12 @@ export declare const QueryConfigSchema: z.ZodObject<{
         as: z.ZodString;
     }, z.core.$strict>>>;
     formatting: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-}, z.core.$strict>;
-export declare const FunnelQueryConfigSchema: z.ZodObject<{
+}, z.core.$strict>, z.ZodObject<{
+    source: z.ZodLiteral<"steps">;
     steps: z.ZodArray<z.ZodObject<{
         name: z.ZodString;
         resource: z.ZodString;
-        metric: z.ZodObject<{
+        select: z.ZodArray<z.ZodObject<{
             agg: z.ZodEnum<{
                 sum: "sum";
                 count: "count";
@@ -208,14 +209,24 @@ export declare const FunnelQueryConfigSchema: z.ZodObject<{
             field: z.ZodOptional<z.ZodString>;
             as: z.ZodString;
             filters: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
-        }, z.core.$strict>;
+        }, z.core.$strict>>;
         filters: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
     }, z.core.$strict>>;
     calcs: z.ZodOptional<z.ZodArray<z.ZodObject<{
         calc: z.ZodString;
         as: z.ZodString;
     }, z.core.$strict>>>;
-}, 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>;
+    formatting: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strict>]>;
 export declare const WidgetPersistedFieldsSchema: z.ZodObject<{
     id: z.ZodString;
     group_id: z.ZodString;

package/dist/schema/widgets/common.js

@@ -123,7 +123,8 @@ export const QueryCalcItemSchema = z.object({
     calc: z.string(),
     as: z.string(),
 }).strict();
-export const QueryConfigSchema = z.object({
+const ResourceQueryConfigSchema = z.object({
+    source: z.literal('resource').optional(),
     resource: z.string(),
     select: z.array(QuerySelectItemSchema).optional(),
     sparkline: z.object({
@@ -141,16 +142,24 @@ export const QueryConfigSchema = z.object({
     calcs: z.array(QueryCalcItemSchema).optional(),
     formatting: z.record(z.string(), z.unknown()).optional(),
 }).strict();
-const FunnelQueryStepSchema = z.object({
+const StepsQuerySelectStepSchema = z.object({
     name: z.string(),
     resource: z.string(),
-    metric: QueryAggregateSelectItemSchema,
+    select: z.array(QueryAggregateSelectItemSchema).min(1),
     filters: FilterExpressionSchema.optional(),
 }).strict();
-export const FunnelQueryConfigSchema = z.object({
-    steps: z.array(FunnelQueryStepSchema).min(1),
-    calcs: z.array(QueryCalcItemSchema).optional(),
-}).strict();
+export const QueryConfigSchema = z.union([
+    ResourceQueryConfigSchema,
+    z.object({
+        source: z.literal('steps'),
+        steps: z.array(StepsQuerySelectStepSchema).min(1),
+        calcs: z.array(QueryCalcItemSchema).optional(),
+        order_by: z.array(QueryOrderByItemSchema).optional(),
+        limit: z.number().int().positive().optional(),
+        offset: z.number().int().nonnegative().optional(),
+        formatting: z.record(z.string(), z.unknown()).optional(),
+    }).strict(),
+]);
 export const WidgetPersistedFieldsSchema = z.object({
     id: z.string(),
     group_id: z.string(),

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

@@ -95,7 +95,8 @@ export declare const GaugeCardWidgetConfigSchema: z.ZodObject<{
         }, z.core.$strict>>;
         color: z.ZodOptional<z.ZodString>;
     }, z.core.$strict>;
-    query: z.ZodObject<{
+    query: z.ZodUnion<readonly [z.ZodObject<{
+        source: z.ZodOptional<z.ZodLiteral<"resource">>;
         resource: z.ZodString;
         select: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
             field: z.ZodString;
@@ -168,5 +169,40 @@ export declare const GaugeCardWidgetConfigSchema: z.ZodObject<{
             as: z.ZodString;
         }, z.core.$strict>>>;
         formatting: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    }, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        source: z.ZodLiteral<"steps">;
+        steps: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            resource: z.ZodString;
+            select: z.ZodArray<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>>;
+            filters: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+        }, z.core.$strict>>;
+        calcs: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            calc: z.ZodString;
+            as: 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>;
+        formatting: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strict>]>;
 }, z.core.$strict>;

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

@@ -135,7 +135,8 @@ export declare const KpiCardWidgetConfigSchema: z.ZodObject<{
             }, z.core.$strict>>;
         }, z.core.$strict>>;
     }, z.core.$strict>;
-    query: z.ZodObject<{
+    query: z.ZodUnion<readonly [z.ZodObject<{
+        source: z.ZodOptional<z.ZodLiteral<"resource">>;
         resource: z.ZodString;
         select: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
             field: z.ZodString;
@@ -208,5 +209,40 @@ export declare const KpiCardWidgetConfigSchema: z.ZodObject<{
             as: z.ZodString;
         }, z.core.$strict>>>;
         formatting: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    }, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        source: z.ZodLiteral<"steps">;
+        steps: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            resource: z.ZodString;
+            select: z.ZodArray<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>>;
+            filters: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+        }, z.core.$strict>>;
+        calcs: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            calc: z.ZodString;
+            as: 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>;
+        formatting: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strict>]>;
 }, z.core.$strict>;

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

@@ -119,7 +119,8 @@ export declare const PivotTableWidgetConfigSchema: z.ZodObject<{
             }>>;
         }, z.core.$strict>>;
     }, z.core.$strict>;
-    query: z.ZodObject<{
+    query: z.ZodUnion<readonly [z.ZodObject<{
+        source: z.ZodOptional<z.ZodLiteral<"resource">>;
         resource: z.ZodString;
         select: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
             field: z.ZodString;
@@ -192,5 +193,40 @@ export declare const PivotTableWidgetConfigSchema: z.ZodObject<{
             as: z.ZodString;
         }, z.core.$strict>>>;
         formatting: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    }, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        source: z.ZodLiteral<"steps">;
+        steps: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            resource: z.ZodString;
+            select: z.ZodArray<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>>;
+            filters: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+        }, z.core.$strict>>;
+        calcs: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            calc: z.ZodString;
+            as: 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>;
+        formatting: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strict>]>;
 }, z.core.$strict>;

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

@@ -53,7 +53,8 @@ export declare const TableWidgetConfigSchema: z.ZodObject<{
         pagination: z.ZodOptional<z.ZodBoolean>;
         page_size: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strict>>;
-    query: z.ZodObject<{
+    query: z.ZodUnion<readonly [z.ZodObject<{
+        source: z.ZodOptional<z.ZodLiteral<"resource">>;
         resource: z.ZodString;
         select: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
             field: z.ZodString;
@@ -126,5 +127,40 @@ export declare const TableWidgetConfigSchema: z.ZodObject<{
             as: z.ZodString;
         }, z.core.$strict>>>;
         formatting: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    }, z.core.$strict>;
+    }, z.core.$strict>, z.ZodObject<{
+        source: z.ZodLiteral<"steps">;
+        steps: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            resource: z.ZodString;
+            select: z.ZodArray<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>>;
+            filters: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+        }, z.core.$strict>>;
+        calcs: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            calc: z.ZodString;
+            as: 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>;
+        formatting: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strict>]>;
 }, z.core.$strict>;

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

@@ -0,0 +1 @@
+export declare function evaluateCalc(calc: string, values: Record<string, unknown>): any;

package/dist/services/calc-evaluator.js

@@ -0,0 +1,28 @@
+import { Parser } from 'expr-eval-fork';
+const CALC_PARSER_OPTIONS = {
+    allowMemberAccess: false,
+    operators: {
+        assignment: false,
+        concatenate: false,
+        conditional: true,
+        comparison: true,
+        fndef: false,
+        in: false,
+        logical: true,
+        random: false,
+    },
+};
+const CALC_PARSER = new Parser(CALC_PARSER_OPTIONS);
+export function evaluateCalc(calc, values) {
+    return CALC_PARSER.parse(calc).evaluate(normalizeCalcValues(values));
+}
+function normalizeCalcValues(values) {
+    return Object.fromEntries(Object.entries(values).map(([key, value]) => [
+        key,
+        typeof value === 'string' ? value : toFiniteNumber(value),
+    ]));
+}
+function toFiniteNumber(value) {
+    const numberValue = typeof value === 'number' ? value : Number(value);
+    return Number.isFinite(numberValue) ? numberValue : 0;
+}

package/dist/services/dashboardFilterService.d.ts

@@ -0,0 +1,5 @@
+import type { IAdminForthAndOrFilter, IAdminForthSingleFilter } from 'adminforth';
+import type { FilterExpression } from '../custom/model/dashboard.types.js';
+export type DashboardQueryFilters = IAdminForthSingleFilter | IAdminForthAndOrFilter | Array<IAdminForthSingleFilter | IAdminForthAndOrFilter>;
+export declare function getAdminForthFilters(filters: FilterExpression | DashboardQueryFilters | undefined): DashboardQueryFilters;
+export declare function mergeFilters(...filters: Array<FilterExpression | DashboardQueryFilters | undefined>): DashboardQueryFilters;

package/dist/services/dashboardFilterService.js

@@ -0,0 +1,125 @@
+import { Filters } from 'adminforth';
+const RELATIVE_DURATION_RE = /^(\d+)(h|d|w|mo|y)$/;
+const FILTER_OPERATORS = {
+    eq: Filters.EQ,
+    neq: Filters.NEQ,
+    gt: Filters.GT,
+    gte: Filters.GTE,
+    lt: Filters.LT,
+    lte: Filters.LTE,
+    in: Filters.IN,
+    not_in: Filters.NOT_IN,
+    like: Filters.LIKE,
+    ilike: Filters.ILIKE,
+};
+export function getAdminForthFilters(filters) {
+    if (Array.isArray(filters)) {
+        return filters.map((filter) => isDashboardFilterExpression(filter)
+            ? toAdminForthFilter(filter)
+            : filter);
+    }
+    if (isDashboardFilterExpression(filters)) {
+        return toAdminForthFilter(filters);
+    }
+    if (filters) {
+        return filters;
+    }
+    return [];
+}
+export function mergeFilters(...filters) {
+    const merged = [];
+    for (const filter of filters) {
+        const normalized = getAdminForthFilters(filter);
+        if (Array.isArray(normalized)) {
+            merged.push(...normalized);
+            continue;
+        }
+        if (normalized) {
+            merged.push(normalized);
+        }
+    }
+    if (!merged.length) {
+        return [];
+    }
+    return merged.length === 1 ? merged[0] : merged;
+}
+function isDashboardFilterExpression(value) {
+    if (Array.isArray(value)) {
+        return true;
+    }
+    if (!isRecord(value)) {
+        return false;
+    }
+    return 'and' in value
+        || 'or' in value
+        || 'eq' in value
+        || 'neq' in value
+        || 'gt' in value
+        || 'gte' in value
+        || 'lt' in value
+        || 'lte' in value
+        || 'in' in value
+        || 'not_in' in value
+        || 'like' in value
+        || 'ilike' in value;
+}
+function toAdminForthFilter(filter) {
+    if (Array.isArray(filter)) {
+        return Filters.AND(filter.map((item) => toAdminForthFilter(item)));
+    }
+    if ('and' in filter) {
+        return Filters.AND(filter.and.map((item) => toAdminForthFilter(item)));
+    }
+    if ('or' in filter) {
+        return Filters.OR(filter.or.map((item) => toAdminForthFilter(item)));
+    }
+    for (const [operator, createFilter] of Object.entries(FILTER_OPERATORS)) {
+        if (Object.prototype.hasOwnProperty.call(filter, operator)) {
+            return createFilter(filter.field, resolveFilterValue(filter[operator]));
+        }
+    }
+    return Filters.AND([]);
+}
+function resolveFilterValue(value) {
+    if (Array.isArray(value)) {
+        return value.map((item) => resolveFilterValue(item));
+    }
+    if (!isRecord(value)) {
+        return value;
+    }
+    if (value.now === true) {
+        return new Date().toISOString();
+    }
+    if (typeof value.now_minus === 'string') {
+        return subtractDuration(new Date(), value.now_minus).toISOString();
+    }
+    return value;
+}
+function subtractDuration(now, duration) {
+    const match = duration.match(RELATIVE_DURATION_RE);
+    if (!match) {
+        throw new Error(`Unsupported relative date duration: ${duration}`);
+    }
+    const amount = Number(match[1]);
+    const unit = match[2];
+    const date = new Date(now);
+    if (unit === 'h') {
+        date.setUTCHours(date.getUTCHours() - amount);
+    }
+    else if (unit === 'd') {
+        date.setUTCDate(date.getUTCDate() - amount);
+    }
+    else if (unit === 'w') {
+        date.setUTCDate(date.getUTCDate() - amount * 7);
+    }
+    else if (unit === 'mo') {
+        date.setUTCMonth(date.getUTCMonth() - amount);
+    }
+    else if (unit === 'y') {
+        date.setUTCFullYear(date.getUTCFullYear() - amount);
+    }
+    return date;
+}
+function isRecord(value) {
+    return typeof value === 'object' && value !== null;
+}