@nocobase/plugin-data-visualization 2.1.0-alpha.30 → 2.1.0-alpha.31

package/dist/client-v2/chart/configs.d.ts

@@ -0,0 +1,290 @@
+/**
+ * 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.
+ */
+import { SchemaProperties } from '@formily/react';
+export type FieldConfigProps = Partial<{
+    name: string;
+    title: string;
+    required: boolean;
+    defaultValue: any;
+    description: string;
+    options: {
+        label: string;
+        value: any;
+    }[];
+    componentProps: Record<string, any>;
+}>;
+export type AnySchemaProperties = SchemaProperties<any, any, any, any, any, any, any, any>;
+export type ConfigType = (FieldConfigProps & {
+    configType?: string;
+}) | ((props?: FieldConfigProps) => AnySchemaProperties) | AnySchemaProperties;
+export type Config = string | ConfigType;
+declare const _default: {
+    field: ({ name, title, required, defaultValue, description }: Partial<{
+        name: string;
+        title: string;
+        required: boolean;
+        defaultValue: any;
+        description: string;
+        options: {
+            label: string;
+            value: any;
+        }[];
+        componentProps: Record<string, any>;
+    }>) => {
+        [x: string]: {
+            title: string;
+            type: string;
+            'x-decorator': string;
+            'x-component': string;
+            'x-reactions': string;
+            required: boolean;
+            description: string;
+            default: any;
+        };
+    };
+    input: ({ name, title, required, defaultValue, description }: Partial<{
+        name: string;
+        title: string;
+        required: boolean;
+        defaultValue: any;
+        description: string;
+        options: {
+            label: string;
+            value: any;
+        }[];
+        componentProps: Record<string, any>;
+    }>) => {
+        [x: string]: {
+            title: string;
+            type: string;
+            'x-decorator': string;
+            'x-component': string;
+            required: boolean;
+            default: any;
+            description: string;
+        };
+    };
+    boolean: ({ name, title, defaultValue, description }: Partial<{
+        name: string;
+        title: string;
+        required: boolean;
+        defaultValue: any;
+        description: string;
+        options: {
+            label: string;
+            value: any;
+        }[];
+        componentProps: Record<string, any>;
+    }>) => {
+        [x: string]: {
+            'x-content': string;
+            type: string;
+            'x-decorator': string;
+            'x-component': string;
+            default: any;
+            description: string;
+        };
+    };
+    select: ({ name, title, required, defaultValue, options, description }: Partial<{
+        name: string;
+        title: string;
+        required: boolean;
+        defaultValue: any;
+        description: string;
+        options: {
+            label: string;
+            value: any;
+        }[];
+        componentProps: Record<string, any>;
+    }>) => {
+        [x: string]: {
+            title: string;
+            type: string;
+            'x-decorator': string;
+            'x-component': string;
+            required: boolean;
+            default: any;
+            description: string;
+            enum: {
+                label: string;
+                value: any;
+            }[];
+        };
+    };
+    radio: ({ name, title, defaultValue, options, description, componentProps }: Partial<{
+        name: string;
+        title: string;
+        required: boolean;
+        defaultValue: any;
+        description: string;
+        options: {
+            label: string;
+            value: any;
+        }[];
+        componentProps: Record<string, any>;
+    }>) => {
+        [x: string]: {
+            title: string;
+            type: string;
+            'x-decorator': string;
+            'x-component': string;
+            'x-component-props': {
+                [x: string]: any;
+            };
+            default: any;
+            description: string;
+            enum: {
+                label: string;
+                value: any;
+            }[];
+        };
+    };
+    percent: ({ name, title, defaultValue, description }: Partial<{
+        name: string;
+        title: string;
+        required: boolean;
+        defaultValue: any;
+        description: string;
+        options: {
+            label: string;
+            value: any;
+        }[];
+        componentProps: Record<string, any>;
+    }>) => {
+        [x: string]: {
+            title: string;
+            type: string;
+            'x-decorator': string;
+            'x-component': string;
+            default: any;
+            description: string;
+            'x-component-props': {
+                suffix: string;
+            };
+        };
+    };
+    xField: {
+        configType: string;
+        name: string;
+        title: string;
+        required: boolean;
+    };
+    yField: {
+        configType: string;
+        name: string;
+        title: string;
+        required: boolean;
+    };
+    seriesField: {
+        configType: string;
+        name: string;
+        title: string;
+    };
+    colorField: {
+        configType: string;
+        name: string;
+        title: string;
+        required: boolean;
+    };
+    isStack: {
+        configType: string;
+        name: string;
+        title: string;
+    };
+    smooth: {
+        configType: string;
+        name: string;
+        title: string;
+    };
+    isPercent: {
+        configType: string;
+        name: string;
+        title: string;
+    };
+    isGroup: {
+        configType: string;
+        name: string;
+        title: string;
+    };
+    size: () => {
+        size: {
+            title: string;
+            type: string;
+            'x-decorator': string;
+            'x-component': string;
+            properties: {
+                type: {
+                    'x-component': string;
+                    'x-component-props': {
+                        allowClear: boolean;
+                    };
+                    default: string;
+                    enum: {
+                        label: string;
+                        value: string;
+                    }[];
+                };
+                fixed: {
+                    type: string;
+                    'x-component': string;
+                    'x-component-props': {
+                        min: number;
+                        addonAfter: string;
+                    };
+                    'x-reactions': {
+                        dependencies: string[];
+                        fulfill: {
+                            state: {
+                                visible: string;
+                            };
+                        };
+                    }[];
+                };
+                ratio: {
+                    type: string;
+                    'x-component': string;
+                    'x-reactions': {
+                        dependencies: string[];
+                        fulfill: {
+                            state: {
+                                visible: string;
+                            };
+                        };
+                    }[];
+                    properties: {
+                        width: {
+                            type: string;
+                            'x-component': string;
+                            'x-component-props': {
+                                placeholder: string;
+                                min: number;
+                            };
+                        };
+                        colon: {
+                            type: string;
+                            'x-component': string;
+                            'x-component-props': {
+                                children: string;
+                            };
+                        };
+                        height: {
+                            type: string;
+                            'x-component': string;
+                            'x-component-props': {
+                                placeholder: string;
+                                min: number;
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+};
+export default _default;

package/dist/client-v2/chart/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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 * from './ChartGroup';
+export * from './types';
+export * from './configs';

package/dist/client-v2/chart/types.d.ts

@@ -0,0 +1,103 @@
+/**
+ * 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.
+ */
+import { ISchema } from '@formily/react';
+import React from 'react';
+import { Config, ConfigType } from './configs';
+export type FieldOption = {
+    value: string;
+    label: string;
+    key: string;
+    alias?: string;
+    name?: string;
+    type?: string;
+    interface?: string;
+    uiSchema?: ISchema;
+    target?: string;
+    targetFields?: FieldOption[];
+};
+export type MeasureProps = {
+    field: string | string[];
+    aggregation?: string;
+    alias?: string;
+};
+export type DimensionProps = {
+    field: string | string[];
+    alias?: string;
+    format?: string;
+};
+export type Transformer = (val: any, ...args: any[]) => string | number;
+export type FieldRenderProps = {
+    label: string;
+    interface?: string;
+    transformer?: Transformer;
+};
+export type RenderProps = {
+    data: Record<string, any>[];
+    general: any;
+    advanced: any;
+    fieldProps: {
+        [field: string]: FieldRenderProps;
+    };
+};
+export interface ChartType {
+    name: string;
+    title: string;
+    enableAdvancedConfig?: boolean;
+    Component: React.FC<any>;
+    schema: ISchema;
+    init?: (fields: FieldOption[], query: {
+        measures?: MeasureProps[];
+        dimensions?: DimensionProps[];
+    }) => {
+        general?: any;
+        advanced?: any;
+    };
+    getProps(props: RenderProps): any;
+    getReference?: () => {
+        title: string;
+        link: string;
+    };
+}
+export type ChartProps = {
+    name: string;
+    title: string;
+    enableAdvancedConfig?: boolean;
+    Component: React.FC<any>;
+    config?: Config[];
+};
+export declare class Chart implements ChartType {
+    name: string;
+    title: string;
+    enableAdvancedConfig: boolean;
+    Component: React.FC<any>;
+    config: Config[];
+    configTypes: Map<string, ConfigType>;
+    constructor({ name, title, enableAdvancedConfig, Component, config }: ChartProps);
+    get schema(): {
+        type?: undefined;
+        properties?: undefined;
+    } | {
+        type: string;
+        properties: any;
+    };
+    addConfigTypes(configs: {
+        [key: string]: ConfigType;
+    }): void;
+    infer(fields: FieldOption[], { measures, dimensions, }: {
+        measures?: MeasureProps[];
+        dimensions?: DimensionProps[];
+    }): {
+        xField: FieldOption;
+        yField: FieldOption;
+        seriesField: FieldOption;
+        colorField: FieldOption;
+        yFields: FieldOption[];
+    };
+    getProps(props: RenderProps): any;
+}

package/dist/client-v2/flow/components/CodeEditor.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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.
+ */
+import React from 'react';
+import { CompletionSource } from '@codemirror/autocomplete';
+export interface CodeEditorProps {
+    language?: string;
+    value?: string;
+    onChange?: (value: string) => void;
+    completions?: CompletionSource | CompletionSource[];
+    rightExtra?: React.ReactNode;
+}
+export type CodeEditorHandle = {
+    insertAtCursor: (text: string) => void;
+    focus: () => void;
+};
+export declare const CodeEditor: React.ForwardRefExoticComponent<CodeEditorProps & React.RefAttributes<CodeEditorHandle>>;

package/dist/client-v2/flow/models/Chart.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+import React from 'react';
+import { EChartsOption, EChartsType } from 'echarts';
+export interface ChartOptions {
+    option: EChartsOption;
+    Component?: React.FC<any>;
+    dataSource: any;
+    onRefReady?: (chart: EChartsType) => void;
+    loading?: boolean;
+}
+export declare const Chart: React.ForwardRefExoticComponent<ChartOptions & React.RefAttributes<EChartsType>>;

package/dist/client-v2/flow/models/ChartBlockModel.d.ts

@@ -0,0 +1,78 @@
+/**
+ * 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.
+ */
+import { ChildPageModel, DataBlockModel } from '@nocobase/client-v2';
+import { SQLResource } from '@nocobase/flow-engine';
+import React from 'react';
+import { ChartOptions } from './Chart';
+import { ChartResource } from '../resources/ChartResource';
+import PluginDataVisualizationClient from '../../plugin';
+type ChartBlockModelStructure = {
+    subModels: {
+        page: ChildPageModel;
+    };
+};
+type ChartProps = {
+    chart: ChartOptions & {
+        optionRaw?: string;
+        Component?: React.FC<any>;
+    };
+};
+export declare class ChartBlockModel extends DataBlockModel<ChartBlockModelStructure> {
+    props: ChartProps;
+    _previousStepParams: any;
+    get resource(): ChartResource<any> | SQLResource<any>;
+    private __onResourceRefresh;
+    onActive(): void;
+    refresh(): Promise<void>;
+    initResource(mode?: string): void;
+    getResourceSettingsInitParams(): any;
+    buildQueryRequest(query: any): Promise<any>;
+    onInit(options: any): Promise<void>;
+    renderComponent(): React.JSX.Element;
+    getFilterFields(): Promise<{
+        name: string;
+        title: string;
+        type: string;
+        interface: string;
+        target?: string;
+        filterable?: {
+            operators: {
+                label: string;
+                value: string;
+            }[];
+        };
+    }[]>;
+    checkResource(query: any): void;
+    applyQuery(query: any): void;
+    setDataResult(): void;
+    applyChartOptions(payload: {
+        mode: 'basic' | 'custom';
+        builder?: any;
+        raw?: string;
+        query?: any;
+    }): Promise<void>;
+    getRegisteredChart(type?: string): import("../..").ChartType;
+    getDataVisualizationPlugin(): PluginDataVisualizationClient;
+    getRegisteredChartGeneral(builder?: any): any;
+    getRegisteredChartFieldProps(query: any, data?: Record<string, any>[]): Record<string, any>;
+    formatRegisteredChartData(data?: Record<string, any>[], fieldProps?: Record<string, any>): {
+        [x: string]: any;
+    }[];
+    getRegisteredChartDisplayFieldProps(fieldProps?: Record<string, any>): {};
+    getRegisteredChartFieldTransformer(field?: any, item?: any): (value: any) => any;
+    getCollectionFieldByPath(query: any, field: string | string[] | undefined): any;
+    applyEvents(raw?: string): Promise<void>;
+    renderChart(): void;
+    onPreview(params: {
+        query: any;
+        chart: any;
+    }, needQueryData?: boolean): Promise<void>;
+    cancelPreview(): Promise<void>;
+}
+export {};

package/dist/client-v2/flow/models/ChartOptionsBuilder.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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.
+ */
+import React from 'react';
+import { type FieldOption } from '../../chart';
+type BuilderFieldOption = Partial<FieldOption> & {
+    label: string;
+    value: string;
+    key?: string;
+};
+export declare const ChartOptionsBuilder: React.FC<{
+    columns?: string[];
+    fieldOptions?: BuilderFieldOption[];
+    query?: any;
+    initialValues: any;
+    onChange: (next: any) => void;
+}>;
+export {};

package/dist/client-v2/flow/models/ChartOptionsBuilder.service.d.ts

@@ -0,0 +1,58 @@
+/**
+ * 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 type ChartTypeKey = 'line' | 'bar' | 'barHorizontal' | 'pie' | 'doughnut' | 'scatter' | 'area' | 'funnel';
+export declare function getChartFormSpec(type: ChartTypeKey): ({
+    kind: string;
+    name: any;
+    labelKey: any;
+    options: any;
+    required?: undefined;
+    allowClear?: undefined;
+    placeholderKey?: undefined;
+    min?: undefined;
+    max?: undefined;
+} | {
+    kind: string;
+    name: any;
+    labelKey: any;
+    required: boolean;
+    allowClear: boolean;
+    placeholderKey: string;
+    options?: undefined;
+    min?: undefined;
+    max?: undefined;
+} | {
+    kind: string;
+    name: any;
+    labelKey: any;
+    options?: undefined;
+    required?: undefined;
+    allowClear?: undefined;
+    placeholderKey?: undefined;
+    min?: undefined;
+    max?: undefined;
+} | {
+    kind: string;
+    name: any;
+    labelKey: any;
+    min: any;
+    max: any;
+    options?: undefined;
+    required?: undefined;
+    allowClear?: undefined;
+    placeholderKey?: undefined;
+})[];
+export declare function buildFieldOptions(columns?: string[]): {
+    label: string;
+    value: string;
+}[];
+export declare function stripInvalidColumns(builder?: {}, columns?: string[]): any;
+export declare function normalizeBuilder(builder: any, columns?: string[]): any;
+export declare function applyTypeChange(builder: {}, nextType: ChartTypeKey, columns?: string[]): any;
+export declare function genRawByBuilder(builder: any): string;

package/dist/client-v2/flow/models/ChartOptionsEditor.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+import React from 'react';
+export declare const ChartOptionsEditor: React.FC<{
+    value?: string;
+    onChange?: (next: string) => void;
+    disabled?: boolean;
+    style?: React.CSSProperties;
+    className?: string;
+}>;

package/dist/client-v2/flow/models/ChartOptionsPanel.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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.
+ */
+import React from 'react';
+export declare const chartOptionDefaultValue = "return {\n  dataset: { source: ctx.data.objects || [] },\n  xAxis: { type: 'category' },\n  yAxis: {},\n  series: [\n    {\n      type: 'line',\n      smooth: true,\n      showSymbol: false,\n    },\n  ],\n}\n";
+export declare const ChartOptionsPanel: React.FC;

package/dist/client-v2/flow/models/ConfigPanel.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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.
+ */
+import React from 'react';
+export declare const ConfigPanel: React.FC;

package/dist/client-v2/flow/models/ECharts.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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.
+ */
+import React from 'react';
+import * as echarts from 'echarts';
+import type { EChartsType, EChartsOption } from 'echarts';
+interface Props {
+    option: EChartsOption;
+    style?: React.CSSProperties;
+    className?: string;
+    theme?: string;
+    onRefReady?: (chart: EChartsType) => void;
+}
+declare const ECharts: React.ForwardRefExoticComponent<Props & React.RefAttributes<echarts.ECharts>>;
+export default ECharts;

package/dist/client-v2/flow/models/EventsEditor.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+declare const EventsEditor: import("react").ForwardRefExoticComponent<Omit<Partial<import("../components/CodeEditor").CodeEditorProps & import("react").RefAttributes<import("../components/CodeEditor").CodeEditorHandle>>, "ref"> & import("react").RefAttributes<unknown>>;
+export default EventsEditor;

package/dist/client-v2/flow/models/EventsPanel.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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.
+ */
+import React from 'react';
+export declare const EventsPanel: React.FC;