@nocobase/plugin-flow-engine 2.1.0-alpha.13 → 2.1.0-alpha.14

package/dist/server/flow-surfaces/chart-config.d.ts

@@ -0,0 +1,121 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+export declare const CHART_DEFAULT_DATA_SOURCE_KEY = "main";
+export declare const CHART_QUERY_MODES: readonly ["builder", "sql"];
+export declare const CHART_VISUAL_MODES: readonly ["basic", "custom"];
+export declare const CHART_BASIC_VISUAL_TYPES: readonly ["line", "area", "bar", "barHorizontal", "pie", "doughnut", "funnel", "scatter"];
+export declare const CHART_QUERY_AGGREGATIONS: readonly ["sum", "count", "avg", "max", "min"];
+export declare const CHART_SORT_DIRECTIONS: readonly ["asc", "desc"];
+export declare const CHART_SORT_NULLS: readonly ["default", "first", "last"];
+export declare const CHART_LABEL_TYPES: readonly ["value", "percent"];
+export declare const CHART_FUNNEL_SORTS: readonly ["descending", "ascending"];
+export type ChartBuilderQueryOutput = {
+    alias: string;
+    source?: 'builder' | 'sql';
+    kind?: 'dimension' | 'measure';
+    field?: string | string[];
+    aggregation?: (typeof CHART_QUERY_AGGREGATIONS)[number];
+    distinct?: boolean;
+    format?: string;
+};
+export type ChartCapabilityHint = {
+    key: string;
+    title: string;
+    description: string;
+};
+export type ChartStyleValueSupport = {
+    type: 'boolean' | 'number' | 'string';
+    enumValues?: string[];
+    min?: number;
+    max?: number;
+    description?: string;
+};
+export declare function deriveChartSemanticState(configure: any): Partial<{
+    query: Partial<{
+        mode: string;
+        sql: any;
+        sqlDatasource: any;
+    }> | Partial<{
+        mode: any;
+        resource: {
+            dataSourceKey: string;
+            collectionName: string;
+        };
+        measures: any;
+        dimensions: any;
+        filter: any;
+        sorting: Partial<{
+            field: any;
+            direction: string;
+            nulls: any;
+        }>[];
+        limit: any;
+        offset: any;
+    }>;
+    visual: Partial<{
+        mode: string;
+        raw: any;
+    }> | Partial<{
+        style?: Partial<{
+            legend: any;
+            tooltip: any;
+            label: any;
+            boundaryGap: any;
+            xAxisLabelRotate: any;
+            yAxisSplitLine: any;
+            smooth: any;
+            stack: any;
+            radiusInner: any;
+            radiusOuter: any;
+            labelType: any;
+            sort: any;
+            minSize: any;
+            maxSize: any;
+        }>;
+        mappings?: Partial<{
+            x: any;
+            y: any;
+            category: any;
+            value: any;
+            series: any;
+            size: any;
+        }>;
+        mode: string;
+        type: string;
+    }>;
+    events: Partial<{
+        raw: any;
+    }>;
+}>;
+export declare function getChartBuilderResourceInit(configure: any): {
+    dataSourceKey: string;
+    collectionName: string;
+};
+export declare function getChartBuilderQueryOutputs(configure: any): ChartBuilderQueryOutput[];
+export declare function getChartBuilderQueryAliases(configure: any): string[];
+export declare function getChartSupportedVisualTypes(): ("line" | "area" | "bar" | "barHorizontal" | "pie" | "doughnut" | "funnel" | "scatter")[];
+export declare function getChartSupportedMappingsByType(): {
+    [k: string]: {
+        allowed: string[];
+        required: string[];
+    };
+};
+export declare function getChartSupportedStylesByType(): {
+    [k: string]: {
+        [k: string]: ChartStyleValueSupport;
+    };
+};
+export declare function getChartSafeDefaultHints(): ChartCapabilityHint[];
+export declare function getChartRiskyPatternHints(): ChartCapabilityHint[];
+export declare function getChartUnsupportedPatternHints(): ChartCapabilityHint[];
+export declare function getChartVisualMappingAliases(input: any): string[];
+export declare function canonicalizeChartConfigure(configure: any): Record<string, any>;
+export declare function buildChartConfigureFromSemanticChanges(currentConfigure: any, changes: Record<string, any>): any;
+export declare function isChartBuilderQuery(configure: any): boolean;
+export declare function getChartVisualCommonStyleKeys(): string[];