@adminforth/dashboard 1.5.0 → 1.6.0

package/dist/schema/widgets/charts.js

@@ -0,0 +1,92 @@
+import { z } from 'zod';
+import { ChartFieldRefSchema, FunnelQueryConfigSchema, QueryConfigSchema, WidgetBaseSchema, } from './common.js';
+const ChartBaseSchema = z.object({
+    title: z.string().optional(),
+}).strict();
+const ChartBucketSchema = z.object({
+    label: z.string().min(1, 'Bucket label is required'),
+    min: z.number().optional(),
+    max: z.number().optional(),
+}).strict();
+const ChartSeriesRefSchema = z.object({
+    field: z.string(),
+    label: z.string().optional(),
+}).strict();
+export const LineChartSchema = ChartBaseSchema.extend({
+    type: z.literal('line'),
+    x: ChartFieldRefSchema,
+    y: z.array(ChartFieldRefSchema).min(1),
+    series: ChartSeriesRefSchema.optional(),
+    color: z.string().optional(),
+    colors: z.array(z.string()).optional(),
+});
+export const BarChartSchema = ChartBaseSchema.extend({
+    type: z.literal('bar'),
+    x: ChartFieldRefSchema,
+    y: ChartFieldRefSchema,
+    color: z.string().optional(),
+});
+export const StackedBarChartSchema = ChartBaseSchema.extend({
+    type: z.literal('stacked_bar'),
+    x: ChartFieldRefSchema,
+    y: z.union([ChartFieldRefSchema, z.array(ChartFieldRefSchema).min(1)]),
+    series: ChartSeriesRefSchema.optional(),
+    colors: z.array(z.string()).optional(),
+});
+export const PieChartSchema = ChartBaseSchema.extend({
+    type: z.literal('pie'),
+    label: ChartFieldRefSchema,
+    value: ChartFieldRefSchema,
+    colors: z.array(z.string()).optional(),
+});
+export const HistogramChartSchema = ChartBaseSchema.extend({
+    type: z.literal('histogram'),
+    x: ChartFieldRefSchema,
+    y: ChartFieldRefSchema,
+    buckets: z.array(ChartBucketSchema).optional(),
+    color: z.string().optional(),
+});
+export const FunnelChartSchema = ChartBaseSchema.extend({
+    type: z.literal('funnel'),
+    label: ChartFieldRefSchema.optional(),
+    value: ChartFieldRefSchema.optional(),
+    colors: z.array(z.string()).optional(),
+});
+export const LineChartWidgetConfigSchema = WidgetBaseSchema.extend({
+    target: z.literal('chart'),
+    chart: LineChartSchema,
+    query: QueryConfigSchema,
+});
+export const BarChartWidgetConfigSchema = WidgetBaseSchema.extend({
+    target: z.literal('chart'),
+    chart: BarChartSchema,
+    query: QueryConfigSchema,
+});
+export const StackedBarChartWidgetConfigSchema = WidgetBaseSchema.extend({
+    target: z.literal('chart'),
+    chart: StackedBarChartSchema,
+    query: QueryConfigSchema,
+});
+export const PieChartWidgetConfigSchema = WidgetBaseSchema.extend({
+    target: z.literal('chart'),
+    chart: PieChartSchema,
+    query: QueryConfigSchema,
+});
+export const HistogramChartWidgetConfigSchema = WidgetBaseSchema.extend({
+    target: z.literal('chart'),
+    chart: HistogramChartSchema,
+    query: QueryConfigSchema,
+});
+export const FunnelChartWidgetConfigSchema = WidgetBaseSchema.extend({
+    target: z.literal('chart'),
+    chart: FunnelChartSchema,
+    query: FunnelQueryConfigSchema,
+});
+export const ChartWidgetTargetConfigSchema = z.union([
+    LineChartWidgetConfigSchema,
+    BarChartWidgetConfigSchema,
+    StackedBarChartWidgetConfigSchema,
+    PieChartWidgetConfigSchema,
+    HistogramChartWidgetConfigSchema,
+    FunnelChartWidgetConfigSchema,
+]);

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

@@ -0,0 +1,275 @@
+import { z } from 'zod';
+export declare const DashboardWidgetSizeSchema: z.ZodEnum<{
+    small: "small";
+    medium: "medium";
+    large: "large";
+    wide: "wide";
+    full: "full";
+}>;
+export declare const ValueFormatSchema: z.ZodOptional<z.ZodEnum<{
+    number: "number";
+    integer: "integer";
+    compact_number: "compact_number";
+    currency: "currency";
+    percent: "percent";
+    percent_delta: "percent_delta";
+    number_delta: "number_delta";
+    currency_delta: "currency_delta";
+}>>;
+export declare const VariablesConfigSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+export declare const ChartFieldRefSchema: z.ZodObject<{
+    field: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    format: z.ZodOptional<z.ZodEnum<{
+        number: "number";
+        integer: "integer";
+        compact_number: "compact_number";
+        currency: "currency";
+        percent: "percent";
+        percent_delta: "percent_delta";
+        number_delta: "number_delta";
+        currency_delta: "currency_delta";
+    }>>;
+}, z.core.$strict>;
+export declare const FilterExpressionSchema: z.ZodType;
+export declare const QueryAggregateOperationSchema: z.ZodEnum<{
+    sum: "sum";
+    count: "count";
+    count_distinct: "count_distinct";
+    avg: "avg";
+    min: "min";
+    max: "max";
+    median: "median";
+}>;
+export declare const QueryFieldSelectItemSchema: 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>;
+export declare const QueryAggregateSelectItemSchema: 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>;
+export declare const QueryCalcSelectItemSchema: z.ZodObject<{
+    calc: z.ZodString;
+    as: z.ZodString;
+}, z.core.$strict>;
+export declare const QuerySelectItemSchema: 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>]>;
+export declare const QueryGroupByItemSchema: 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>]>;
+export declare const QueryOrderByItemSchema: z.ZodObject<{
+    field: z.ZodString;
+    direction: z.ZodOptional<z.ZodEnum<{
+        asc: "asc";
+        desc: "desc";
+    }>>;
+}, z.core.$strict>;
+export declare const QueryCalcItemSchema: z.ZodObject<{
+    calc: z.ZodString;
+    as: z.ZodString;
+}, z.core.$strict>;
+export declare const QueryConfigSchema: z.ZodObject<{
+    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 FunnelQueryConfigSchema: z.ZodObject<{
+    steps: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        resource: z.ZodString;
+        metric: 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>>>;
+}, z.core.$strict>;
+export declare const WidgetPersistedFieldsSchema: z.ZodObject<{
+    id: z.ZodString;
+    group_id: z.ZodString;
+    order: z.ZodNumber;
+}, z.core.$strict>;
+export declare const WidgetEditableBaseSchema: z.ZodObject<{
+    label: z.ZodOptional<z.ZodString>;
+    variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    size: z.ZodOptional<z.ZodEnum<{
+        small: "small";
+        medium: "medium";
+        large: "large";
+        wide: "wide";
+        full: "full";
+    }>>;
+    width: z.ZodOptional<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+    min_width: z.ZodOptional<z.ZodNumber>;
+    max_width: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+}, z.core.$strict>;
+export declare const WidgetBaseSchema: z.ZodObject<{
+    id: z.ZodString;
+    group_id: z.ZodString;
+    order: z.ZodNumber;
+    label: z.ZodOptional<z.ZodString>;
+    variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    size: z.ZodOptional<z.ZodEnum<{
+        small: "small";
+        medium: "medium";
+        large: "large";
+        wide: "wide";
+        full: "full";
+    }>>;
+    width: z.ZodOptional<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+    min_width: z.ZodOptional<z.ZodNumber>;
+    max_width: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+}, z.core.$strict>;
+export declare const EmptyWidgetConfigSchema: z.ZodObject<{
+    id: z.ZodString;
+    group_id: z.ZodString;
+    order: z.ZodNumber;
+    label: z.ZodOptional<z.ZodString>;
+    variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    size: z.ZodOptional<z.ZodEnum<{
+        small: "small";
+        medium: "medium";
+        large: "large";
+        wide: "wide";
+        full: "full";
+    }>>;
+    width: z.ZodOptional<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+    min_width: z.ZodOptional<z.ZodNumber>;
+    max_width: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    target: z.ZodLiteral<"empty">;
+}, z.core.$strict>;

package/dist/schema/widgets/common.js

@@ -0,0 +1,171 @@
+import { z } from 'zod';
+export const DashboardWidgetSizeSchema = z.enum([
+    'small',
+    'medium',
+    'large',
+    'wide',
+    'full',
+]);
+export const ValueFormatSchema = z.enum([
+    'number',
+    'integer',
+    'compact_number',
+    'currency',
+    'percent',
+    'percent_delta',
+    'number_delta',
+    'currency_delta',
+]).optional();
+export const VariablesConfigSchema = z.record(z.string(), z.unknown());
+export const ChartFieldRefSchema = z.object({
+    field: z.string(),
+    label: z.string().optional(),
+    format: ValueFormatSchema,
+}).strict();
+const RelativeDateValueSchema = z.union([
+    z.object({
+        now: z.literal(true),
+    }).strict(),
+    z.object({
+        now_minus: z.string().regex(/^\d+(h|d|w|mo|y)$/),
+    }).strict(),
+]);
+const FilterValueSchema = z.lazy(() => z.union([
+    RelativeDateValueSchema,
+    z.string(),
+    z.number(),
+    z.boolean(),
+    z.null(),
+    z.array(FilterValueSchema),
+    z.record(z.string(), FilterValueSchema),
+]));
+export const FilterExpressionSchema = z.lazy(() => z.union([
+    z.array(FilterExpressionSchema),
+    z.object({
+        and: z.array(FilterExpressionSchema),
+    }).strict(),
+    z.object({
+        or: z.array(FilterExpressionSchema),
+    }).strict(),
+    z.object({
+        field: z.string(),
+        eq: FilterValueSchema.optional(),
+        neq: FilterValueSchema.optional(),
+        gt: FilterValueSchema.optional(),
+        gte: FilterValueSchema.optional(),
+        lt: FilterValueSchema.optional(),
+        lte: FilterValueSchema.optional(),
+        in: z.array(FilterValueSchema).optional(),
+        not_in: z.array(FilterValueSchema).optional(),
+        like: FilterValueSchema.optional(),
+        ilike: FilterValueSchema.optional(),
+    }).strict(),
+]));
+export const QueryAggregateOperationSchema = z.enum([
+    'sum',
+    'count',
+    'count_distinct',
+    'avg',
+    'min',
+    'max',
+    'median',
+]);
+export const QueryFieldSelectItemSchema = z.object({
+    field: z.string(),
+    as: z.string().optional(),
+    grain: z.enum(['day', 'week', 'month', 'year']).optional(),
+}).strict();
+export const QueryAggregateSelectItemSchema = z.object({
+    agg: QueryAggregateOperationSchema,
+    field: z.string().optional(),
+    as: z.string(),
+    filters: FilterExpressionSchema.optional(),
+}).strict().superRefine((item, ctx) => {
+    if (!['count'].includes(item.agg) && !item.field) {
+        ctx.addIssue({
+            code: 'custom',
+            path: ['field'],
+            message: `field is required for ${item.agg}`,
+        });
+    }
+});
+export const QueryCalcSelectItemSchema = z.object({
+    calc: z.string(),
+    as: z.string(),
+}).strict();
+export const QuerySelectItemSchema = z.union([
+    QueryFieldSelectItemSchema,
+    QueryAggregateSelectItemSchema,
+    QueryCalcSelectItemSchema,
+]);
+export const QueryGroupByItemSchema = z.union([
+    z.string(),
+    z.object({
+        field: z.string(),
+        as: z.string().optional(),
+        grain: z.enum(['day', 'week', 'month', 'year']).optional(),
+        timezone: z.string().optional(),
+    }).strict(),
+]);
+export const QueryOrderByItemSchema = z.object({
+    field: z.string(),
+    direction: z.enum(['asc', 'desc']).optional(),
+}).strict();
+const BucketConfigSchema = z.object({
+    field: z.string(),
+    buckets: z.array(z.object({
+        label: z.string(),
+        min: z.number().optional(),
+        max: z.number().optional(),
+    }).strict()),
+}).strict();
+export const QueryCalcItemSchema = z.object({
+    calc: z.string(),
+    as: z.string(),
+}).strict();
+export const QueryConfigSchema = z.object({
+    resource: z.string(),
+    select: z.array(QuerySelectItemSchema).optional(),
+    sparkline: z.object({
+        field: z.string(),
+        grain: z.enum(['day', 'week', 'month', 'year']),
+        as: z.string(),
+        fill_missing: z.record(z.string(), z.unknown()).optional(),
+    }).strict().optional(),
+    filters: FilterExpressionSchema.optional(),
+    group_by: z.array(QueryGroupByItemSchema).optional(),
+    order_by: z.array(QueryOrderByItemSchema).optional(),
+    limit: z.number().int().positive().optional(),
+    offset: z.number().int().nonnegative().optional(),
+    bucket: BucketConfigSchema.optional(),
+    calcs: z.array(QueryCalcItemSchema).optional(),
+    formatting: z.record(z.string(), z.unknown()).optional(),
+}).strict();
+const FunnelQueryStepSchema = z.object({
+    name: z.string(),
+    resource: z.string(),
+    metric: QueryAggregateSelectItemSchema,
+    filters: FilterExpressionSchema.optional(),
+}).strict();
+export const FunnelQueryConfigSchema = z.object({
+    steps: z.array(FunnelQueryStepSchema).min(1),
+    calcs: z.array(QueryCalcItemSchema).optional(),
+}).strict();
+export const WidgetPersistedFieldsSchema = z.object({
+    id: z.string(),
+    group_id: z.string(),
+    order: z.number(),
+}).strict();
+export const WidgetEditableBaseSchema = z.object({
+    label: z.string().optional(),
+    variables: VariablesConfigSchema.optional(),
+    size: DashboardWidgetSizeSchema.optional(),
+    width: z.number().positive('Width must be greater than 0').optional(),
+    height: z.number().positive('Height must be greater than 0').optional(),
+    min_width: z.number().nonnegative('Min width must be a non-negative number').optional(),
+    max_width: z.number().nonnegative('Max width must be a non-negative number').nullable().optional(),
+}).strict();
+export const WidgetBaseSchema = WidgetPersistedFieldsSchema.merge(WidgetEditableBaseSchema);
+export const EmptyWidgetConfigSchema = WidgetBaseSchema.extend({
+    target: z.literal('empty'),
+});