@adminforth/dashboard 1.3.0 → 1.4.1

package/dist/custom/model/dashboard.types.d.ts

@@ -4,34 +4,44 @@ export type DashboardConfig = {
     groups: DashboardGroupConfig[];
     widgets: DashboardWidgetConfig[];
 };
+export type JsonValue = string | number | boolean | null | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+export type DashboardVariables = Record<string, JsonValue>;
 export type DashboardGroupConfig = {
     id: string;
     label: string;
     order: number;
 };
+export type EditableDashboardGroupConfig = Pick<DashboardGroupConfig, 'label'>;
 export type DashboardGroupMoveDirection = 'up' | 'down';
 export type DashboardWidgetMoveDirection = 'up' | 'down';
 export type DashboardWidgetTarget = 'empty' | 'table' | 'chart' | 'kpi_card' | 'pivot_table' | 'gauge_card';
 export type DashboardWidgetSize = 'small' | 'medium' | 'large' | 'wide' | 'full';
+export type DashboardWidgetConfigValidationError = {
+    field: string;
+    message: string;
+};
 export type QueryAggregateOperation = 'sum' | 'count' | 'count_distinct' | 'avg' | 'min' | 'max' | 'median';
-export type TimeGrain = 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year';
+export type TimeGrain = 'day' | 'week' | 'month' | 'year';
 export type ValueFormat = 'number' | 'compact_number' | 'currency' | 'percent' | 'percent_delta' | 'number_delta' | 'currency_delta';
 export type WidgetLayout = {
     size?: DashboardWidgetSize;
     width?: number;
-    minWidth?: number;
-    maxWidth?: number | null;
+    min_width?: number;
+    max_width?: number | null;
     height?: number;
 };
 export type WidgetBaseConfig = {
     id: string;
     group_id: string;
     label?: string;
+    variables?: DashboardVariables;
     size?: DashboardWidgetSize;
     width?: number;
     height?: number;
-    minWidth?: number;
-    maxWidth?: number | null;
+    min_width?: number;
+    max_width?: number | null;
     order: number;
 };
 export type FilterExpression = {
@@ -40,16 +50,16 @@ export type FilterExpression = {
     or: FilterExpression[];
 } | Array<FilterExpression> | {
     field: string;
-    eq?: unknown;
-    neq?: unknown;
-    gt?: unknown;
-    gte?: unknown;
-    lt?: unknown;
-    lte?: unknown;
-    in?: unknown[];
-    not_in?: unknown[];
-    like?: unknown;
-    ilike?: unknown;
+    eq?: JsonValue;
+    neq?: JsonValue;
+    gt?: JsonValue;
+    gte?: JsonValue;
+    lt?: JsonValue;
+    lte?: JsonValue;
+    in?: JsonValue[];
+    not_in?: JsonValue[];
+    like?: JsonValue;
+    ilike?: JsonValue;
 };
 export type QueryFieldSelectItem = {
     field: string;
@@ -81,19 +91,19 @@ export type QueryConfig = {
     resource: string;
     select?: QuerySelectItem[];
     filters?: FilterExpression;
-    groupBy?: QueryGroupByItem[];
-    orderBy?: QueryOrderByItem[];
+    group_by?: QueryGroupByItem[];
+    order_by?: QueryOrderByItem[];
     limit?: number;
     offset?: number;
-    timeSeries?: {
+    time_series?: {
         field: string;
         grain: TimeGrain;
         timezone?: string;
     };
     period?: {
         field: string;
-        gte?: unknown;
-        lt?: unknown;
+        gte?: JsonValue;
+        lt?: JsonValue;
     };
     bucket?: {
         field: string;
@@ -104,10 +114,11 @@ export type QueryConfig = {
         }>;
     };
     calcs?: QueryCalcSelectItem[];
-    formatting?: Record<string, unknown>;
+    formatting?: Record<string, JsonValue>;
 };
 export type FunnelQueryConfig = {
     steps: FunnelQueryStep[];
+    calcs?: QueryCalcSelectItem[];
 };
 export type FunnelQueryStep = {
     name: string;
@@ -123,7 +134,7 @@ export type FieldRef = string | {
 export type TableViewConfig = {
     columns?: FieldRef[];
     pagination?: boolean;
-    pageSize?: number;
+    page_size?: number;
 };
 export type KpiCardViewConfig = {
     title?: string;
@@ -137,8 +148,8 @@ export type KpiCardViewConfig = {
         text?: string;
         field?: string;
     };
-    comparison?: unknown;
-    sparkline?: unknown;
+    comparison?: JsonValue;
+    sparkline?: JsonValue;
 };
 export type GaugeCardViewConfig = {
     title?: string;
@@ -154,9 +165,9 @@ export type GaugeCardViewConfig = {
         label?: string;
     };
     progress?: {
-        valueField: string;
-        targetValue?: number;
-        targetField?: string;
+        value_field: string;
+        target_value?: number;
+        target_field?: string;
         format?: ValueFormat;
     };
     color?: string;
@@ -200,6 +211,7 @@ export type PivotTableWidgetConfig = WidgetBaseConfig & {
     query: QueryConfig;
 };
 export type DashboardWidgetConfig = EmptyWidgetConfig | TableWidgetConfig | ChartDashboardWidgetConfig | KpiCardWidgetConfig | GaugeCardWidgetConfig | PivotTableWidgetConfig;
+export type EditableDashboardWidgetConfig = Omit<EmptyWidgetConfig, 'id' | 'group_id' | 'order'> | Omit<TableWidgetConfig, 'id' | 'group_id' | 'order'> | Omit<ChartDashboardWidgetConfig, 'id' | 'group_id' | 'order'> | Omit<KpiCardWidgetConfig, 'id' | 'group_id' | 'order'> | Omit<GaugeCardWidgetConfig, 'id' | 'group_id' | 'order'> | Omit<PivotTableWidgetConfig, 'id' | 'group_id' | 'order'>;
 export type DashboardWidgetTableData = {
     kind?: 'table';
     columns: string[];
@@ -224,8 +236,5 @@ export type DashboardWidgetAggregateData = {
     };
 };
 export type DashboardWidgetData = DashboardWidgetTableData | DashboardWidgetAggregateData;
-export declare function normalizeDashboardConfig(config: unknown): DashboardConfig;
-export declare function normalizeDashboardWidgetConfig(config: unknown): unknown;
-export declare function serializeDashboardWidgetConfigForEditor(widget: DashboardWidgetConfig): Record<string, unknown>;
+export declare function serializeDashboardWidgetConfigForEditor(widget: DashboardWidgetConfig): unknown;
 export declare function getFieldRefField(value: FieldRef | undefined): string | undefined;
-export declare function getFieldRefLabel(value: FieldRef | undefined): string | undefined;

package/dist/custom/model/dashboard.types.js

@@ -1,161 +1,22 @@
 "use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeDashboardConfig = normalizeDashboardConfig;
-exports.normalizeDashboardWidgetConfig = normalizeDashboardWidgetConfig;
 exports.serializeDashboardWidgetConfigForEditor = serializeDashboardWidgetConfigForEditor;
 exports.getFieldRefField = getFieldRefField;
-exports.getFieldRefLabel = getFieldRefLabel;
-function normalizeDashboardConfig(config) {
-    const value = isRecord(config) ? config : {};
-    return {
-        version: typeof value.version === 'number' ? value.version : 1,
-        groups: Array.isArray(value.groups) ? value.groups : [],
-        widgets: Array.isArray(value.widgets)
-            ? value.widgets.map((widget) => normalizeDashboardWidgetConfig(widget))
-            : [],
-    };
-}
-function normalizeDashboardWidgetConfig(config) {
-    if (!isRecord(config)) {
-        return config;
-    }
-    const normalized = Object.assign({}, config);
-    normalizeWidgetLayoutConfig(normalized);
-    if (normalized.query !== undefined) {
-        normalized.query = normalizeQueryConfig(normalized.query);
-    }
-    if (normalized.table !== undefined) {
-        normalized.table = normalizeTableConfig(normalized.table);
-    }
-    if (normalized.card !== undefined) {
-        normalized.card = normalizeCardConfig(normalized.card);
-    }
-    if (normalized.pivot !== undefined) {
-        normalized.pivot = normalizePivotConfig(normalized.pivot);
-    }
-    const target = normalizeDashboardWidgetTarget(normalized.target);
-    if (target !== undefined) {
-        normalized.target = target;
-    }
-    return normalized;
-}
 function serializeDashboardWidgetConfigForEditor(widget) {
-    const serialized = Object.assign({}, widget);
-    if (Object.prototype.hasOwnProperty.call(serialized, 'minWidth')) {
-        serialized.min_width = widget.minWidth;
-        delete serialized.minWidth;
-    }
-    if (Object.prototype.hasOwnProperty.call(serialized, 'maxWidth')) {
-        serialized.max_width = widget.maxWidth;
-        delete serialized.maxWidth;
-    }
-    if ('query' in widget) {
-        serialized.query = serializeQueryConfigForEditor(widget.query);
-    }
-    if ('table' in widget && widget.table !== undefined) {
-        serialized.table = serializeTableConfigForEditor(widget.table);
-    }
-    if ('card' in widget && widget.card !== undefined) {
-        serialized.card = serializeCardConfigForEditor(widget.card);
-    }
-    if ('pivot' in widget && widget.pivot !== undefined) {
-        serialized.pivot = serializePivotConfigForEditor(widget.pivot);
-    }
-    return serialized;
+    const { id: _id, group_id: _groupId, order: _order } = widget, editableWidget = __rest(widget, ["id", "group_id", "order"]);
+    return editableWidget;
 }
 function getFieldRefField(value) {
     return typeof value === 'string' ? value : value === null || value === void 0 ? void 0 : value.field;
 }
-function getFieldRefLabel(value) {
-    return typeof value === 'string' ? value : value === null || value === void 0 ? void 0 : value.label;
-}
-function normalizeDashboardWidgetTarget(value) {
-    switch (value) {
-        case 'empty':
-        case 'table':
-        case 'chart':
-        case 'kpi_card':
-        case 'pivot_table':
-        case 'gauge_card':
-            return value;
-        default:
-            return undefined;
-    }
-}
-function normalizeWidgetLayoutConfig(value) {
-    if (value.min_width !== undefined) {
-        value.minWidth = value.min_width;
-    }
-    if (value.max_width !== undefined) {
-        value.maxWidth = value.max_width;
-    }
-}
-function normalizeQueryConfig(value) {
-    if (!isRecord(value)) {
-        return value;
-    }
-    if (Array.isArray(value.steps)) {
-        return {
-            steps: value.steps.map((step) => normalizeFunnelQueryStep(step)),
-        };
-    }
-    return Object.assign(Object.assign(Object.assign(Object.assign({}, value), (Array.isArray(value.group_by) ? { groupBy: value.group_by } : {})), (Array.isArray(value.order_by) ? { orderBy: value.order_by } : {})), (value.time_series !== undefined ? { timeSeries: value.time_series } : {}));
-}
-function normalizeFunnelQueryStep(value) {
-    if (!isRecord(value)) {
-        return value;
-    }
-    return Object.assign(Object.assign({}, value), (typeof value.resource_id === 'string' ? { resource: value.resource_id } : {}));
-}
-function normalizeTableConfig(value) {
-    if (!isRecord(value)) {
-        return value;
-    }
-    return Object.assign(Object.assign({}, value), (value.page_size !== undefined ? { pageSize: value.page_size } : {}));
-}
-function normalizeCardConfig(value) {
-    if (!isRecord(value)) {
-        return value;
-    }
-    const normalized = Object.assign({}, value);
-    if (isRecord(normalized.progress)) {
-        normalized.progress = Object.assign(Object.assign(Object.assign(Object.assign({}, normalized.progress), (normalized.progress.value_field !== undefined ? { valueField: normalized.progress.value_field } : {})), (normalized.progress.target_value !== undefined ? { targetValue: normalized.progress.target_value } : {})), (normalized.progress.target_field !== undefined ? { targetField: normalized.progress.target_field } : {}));
-    }
-    if (isRecord(normalized.comparison)) {
-        normalized.comparison = Object.assign(Object.assign({}, normalized.comparison), (normalized.comparison.positive_is_good !== undefined ? { positiveIsGood: normalized.comparison.positive_is_good } : {}));
-    }
-    return normalized;
-}
-function normalizePivotConfig(value) {
-    return value;
-}
-function serializeQueryConfigForEditor(value) {
-    if ('steps' in value) {
-        return {
-            steps: value.steps.map((step) => (Object.assign(Object.assign({}, step), { resource_id: step.resource, resource: undefined }))).map((step) => removeUndefinedFields(step)),
-        };
-    }
-    return removeUndefinedFields(Object.assign(Object.assign({}, value), { group_by: value.groupBy, groupBy: undefined, order_by: value.orderBy, orderBy: undefined, time_series: value.timeSeries, timeSeries: undefined }));
-}
-function serializeTableConfigForEditor(value) {
-    return removeUndefinedFields(Object.assign(Object.assign({}, value), { page_size: value.pageSize, pageSize: undefined }));
-}
-function serializeCardConfigForEditor(value) {
-    const serialized = Object.assign({}, value);
-    if (isRecord(serialized.progress)) {
-        serialized.progress = removeUndefinedFields(Object.assign(Object.assign({}, serialized.progress), { value_field: serialized.progress.valueField, valueField: undefined, target_value: serialized.progress.targetValue, targetValue: undefined, target_field: serialized.progress.targetField, targetField: undefined }));
-    }
-    if (isRecord(serialized.comparison)) {
-        serialized.comparison = removeUndefinedFields(Object.assign(Object.assign({}, serialized.comparison), { positive_is_good: serialized.comparison.positiveIsGood, positiveIsGood: undefined }));
-    }
-    return removeUndefinedFields(serialized);
-}
-function serializePivotConfigForEditor(value) {
-    return value;
-}
-function removeUndefinedFields(value) {
-    return Object.fromEntries(Object.entries(value).filter(([, item]) => item !== undefined));
-}
-function isRecord(value) {
-    return typeof value === 'object' && value !== null;
-}