@nocobase/plugin-data-visualization 2.1.0-alpha.4 → 2.1.0-alpha.45

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.
+ */
+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 AnySchema = Record<string, any>;
+export type AnySchemaProperties = Record<string, AnySchema>;
+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,102 @@
+/**
+ * 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 { AnySchema, Config, ConfigType } from './configs';
+export type FieldOption = {
+    value: string;
+    label: string;
+    key: string;
+    alias?: string;
+    name?: string;
+    type?: string;
+    interface?: string;
+    uiSchema?: AnySchema;
+    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: AnySchema;
+    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 → client-v2}/flow/models/Chart.d.ts

@@ -10,8 +10,10 @@ 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;
+    heightMode?: string;
 }
 export declare const Chart: React.ForwardRefExoticComponent<ChartOptions & React.RefAttributes<EChartsType>>;

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

@@ -6,11 +6,12 @@
  * 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';
+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;
@@ -19,6 +20,7 @@ type ChartBlockModelStructure = {
 type ChartProps = {
     chart: ChartOptions & {
         optionRaw?: string;
+        Component?: React.FC<any>;
     };
 };
 export declare class ChartBlockModel extends DataBlockModel<ChartBlockModelStructure> {
@@ -30,6 +32,7 @@ export declare class ChartBlockModel extends DataBlockModel<ChartBlockModelStruc
     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<{
@@ -52,7 +55,19 @@ export declare class ChartBlockModel extends DataBlockModel<ChartBlockModelStruc
         mode: 'basic' | 'custom';
         builder?: any;
         raw?: string;
+        query?: any;
     }): Promise<void>;
+    getRegisteredChart(type?: string): import("../..").ChartType;
+    getV2DataVisualizationPlugin(): PluginDataVisualizationClient;
+    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: {

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

@@ -7,8 +7,17 @@
  * 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 → client-v2}/flow/models/ECharts.d.ts

@@ -9,12 +9,14 @@
 import React from 'react';
 import * as echarts from 'echarts';
 import type { EChartsType, EChartsOption } from 'echarts';
+import './chartBlock.css';
 interface Props {
     option: EChartsOption;
     style?: React.CSSProperties;
     className?: string;
     theme?: string;
     onRefReady?: (chart: EChartsType) => void;
+    fillHeight?: boolean;
 }
 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,14 @@
+/**
+ * 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';
+declare const EventsEditor: React.FC<{
+    value?: string;
+    onChange?: (value: string) => void;
+}>;
+export default EventsEditor;

package/dist/{client → client-v2}/flow/models/QueryBuilder.d.ts

@@ -10,7 +10,20 @@ import React from 'react';
 export type QueryBuilderRef = {
     validate: () => Promise<any>;
 };
+type QueryValue = {
+    collectionPath?: string[];
+    measures?: any[];
+    dimensions?: any[];
+    filter?: {
+        logic: '$and' | '$or';
+        items: any[];
+    };
+    orders?: any[];
+    limit?: number;
+    offset?: number;
+};
 export declare const QueryBuilder: React.ForwardRefExoticComponent<{
-    initialValues?: any;
-    onChange?: (v: any) => void;
+    value?: QueryValue;
+    onChange?: (value: QueryValue) => void;
 } & React.RefAttributes<QueryBuilderRef>>;
+export {};

package/dist/{client/flow/components/DaraButton.d.ts → client-v2/flow/models/SQLEditor.d.ts}

@@ -7,8 +7,9 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 import React from 'react';
-import type { FlowSettingsContext } from '@nocobase/flow-engine';
-export declare const DaraButton: React.FC<{
-    ctx: FlowSettingsContext<any>;
+export declare const SQLEditor: React.FC<{
+    value?: string;
+    onChange?: (value: string) => void;
+    dataSource?: string;
+    onDataSourceChange?: (value: string) => void;
 }>;
-export default DaraButton;

package/dist/{client → client-v2}/flow/models/config-store.d.ts

@@ -14,7 +14,11 @@ interface ConfigState {
         };
     };
     setResult: (uid: string, result: any) => void;
-    setError?: (uid: string, error: string) => void;
+    setError: (uid: string, error: string) => void;
 }
-export declare const configStore: ConfigState;
+type ConfigStore = ConfigState & {
+    version: number;
+    subscribe: (listener: () => void) => () => void;
+};
+export declare const configStore: ConfigStore;
 export {};

package/dist/{client → client-v2}/flow/resources/ChartResource.d.ts

@@ -30,6 +30,7 @@ export declare class ChartResource<TData = any> extends BaseRecordResource<TData
         orders: any;
         limit: any;
         offset: any;
+        contextParams: any;
     };
     run(): Promise<any>;
     refresh(): Promise<void>;

package/dist/{client → client-v2}/flow/utils.d.ts

@@ -40,3 +40,11 @@ export declare function sleep(ms: number): Promise<void>;
 export declare function appendColon(label: string, lang?: string): string;
 export declare const isDebugEnabled: () => boolean;
 export declare const debugLog: (...args: any[]) => void;
+export declare const useCompile: () => (source: any) => any;
+export declare const parseField: (field: string | string[]) => {
+    target: string;
+    name: string;
+    alias: string;
+};
+export declare const removeUnparsableFilter: (filter: any) => any;
+export declare const isEmptyFilterObject: (filter: any) => boolean;

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

@@ -0,0 +1,9 @@
+/**
+ * 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 './useSetChartSize';

package/dist/{client/flow/models/EventsEditor.d.ts → client-v2/hooks/useSetChartSize.d.ts}

@@ -7,5 +7,14 @@
  * 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;
+export declare const useSetChartSize: (size?: {
+    type?: 'fixed' | 'ratio';
+    ratio?: {
+        width: number;
+        height: number;
+    };
+    fixed?: number;
+}, fixedHeight?: number) => {
+    chartRef: import("react").MutableRefObject<HTMLDivElement>;
+    chartHeight: number;
+};

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

@@ -0,0 +1,12 @@
+/**
+ * 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 { default } from './plugin';
+export * from './plugin';
+export * from './chart';
+export * from './hooks';