@nocobase/plugin-data-visualization 0.11.1-alpha.5 → 0.12.0-alpha.2

package/client.d.ts

@@ -1,3 +1,3 @@
 // @ts-nocheck
-export * from './lib/client';
-export { default } from './lib/client';
+export * from './dist/client';
+export { default } from './dist/client';

package/client.js

@@ -39,7 +39,7 @@ function _interopRequireWildcard(obj, nodeInterop) {
   return newObj;
 }
 
-var _index = _interopRequireWildcard(require('./lib/client'));
+var _index = _interopRequireWildcard(require('./dist/client'));
 
 Object.defineProperty(exports, '__esModule', {
   value: true,

package/dist/client/chart/antd/antd.d.ts

@@ -0,0 +1,7 @@
+import { Chart } from '../chart';
+export declare class AntdChart extends Chart {
+    getReference(): {
+        title: string;
+        link: string;
+    };
+}

package/dist/client/chart/antd/index.d.ts

@@ -0,0 +1,4 @@
+import { Statistic } from './statistic';
+import { Table } from './table';
+declare const _default: (Statistic | Table)[];
+export default _default;

package/dist/client/chart/antd/statistic.d.ts

@@ -0,0 +1,19 @@
+import { ISchema } from '@formily/react';
+import { AntdChart } from './antd';
+import { FieldOption } from '../../hooks';
+import { QueryProps } from '../../renderer';
+import { RenderProps } from '../chart';
+export declare class Statistic extends AntdChart {
+    schema: ISchema;
+    constructor();
+    init(fields: FieldOption[], { measures, dimensions, }: {
+        measures?: QueryProps['measures'];
+        dimensions?: QueryProps['dimensions'];
+    }): {
+        general: {
+            field: string;
+            title: string;
+        };
+    };
+    getProps({ data, fieldProps, general, advanced }: RenderProps): any;
+}

package/dist/client/chart/antd/table.d.ts

@@ -0,0 +1,6 @@
+import { RenderProps } from '../chart';
+import { AntdChart } from './antd';
+export declare class Table extends AntdChart {
+    constructor();
+    getProps({ data, fieldProps, general, advanced }: RenderProps): any;
+}

package/dist/client/chart/chart.d.ts

@@ -0,0 +1,65 @@
+import React from 'react';
+import { FieldOption } from '../hooks';
+import { QueryProps } from '../renderer';
+import { ISchema } from '@formily/react';
+export type RenderProps = {
+    data: any[];
+    general: any;
+    advanced: any;
+    fieldProps: {
+        [field: string]: FieldOption & {
+            transformer: (val: any) => string;
+        };
+    };
+};
+export interface ChartType {
+    name: string;
+    title: string;
+    component: React.FC<any>;
+    schema: ISchema;
+    infer: (fields: FieldOption[], { measures, dimensions, }: {
+        measures?: QueryProps['measures'];
+        dimensions?: QueryProps['dimensions'];
+    }) => {
+        xField: FieldOption;
+        yField: FieldOption;
+        seriesField: FieldOption;
+        yFields: FieldOption[];
+    };
+    init?: (fields: FieldOption[], query: {
+        measures?: QueryProps['measures'];
+        dimensions?: QueryProps['dimensions'];
+    }) => {
+        general?: any;
+        advanced?: any;
+    };
+    /**
+     * getProps
+     * Accept the information that the chart component needs to render,
+     * process it and return the props of the chart component.
+     */
+    getProps: (props: RenderProps) => any;
+    getReference?: () => {
+        title: string;
+        link: string;
+    };
+    render: (props: RenderProps) => React.FC<any>;
+}
+export declare class Chart implements ChartType {
+    name: string;
+    title: string;
+    component: React.FC<any>;
+    schema: {};
+    constructor(name: string, title: string, component: React.FC<any>);
+    infer(fields: FieldOption[], { measures, dimensions, }: {
+        measures?: QueryProps['measures'];
+        dimensions?: QueryProps['dimensions'];
+    }): {
+        xField: FieldOption;
+        yField: FieldOption;
+        seriesField: FieldOption;
+        yFields: FieldOption[];
+    };
+    getProps(props: RenderProps): RenderProps;
+    render({ data, general, advanced, fieldProps }: RenderProps): () => React.FunctionComponentElement<any>;
+}

package/dist/client/chart/g2plot/bar.d.ts

@@ -0,0 +1,16 @@
+import { FieldOption } from '../../hooks';
+import { QueryProps } from '../../renderer';
+import { G2PlotChart } from './g2plot';
+export declare class Bar extends G2PlotChart {
+    constructor();
+    init(fields: FieldOption[], { measures, dimensions, }: {
+        measures?: QueryProps['measures'];
+        dimensions?: QueryProps['dimensions'];
+    }): {
+        general: {
+            xField: string;
+            yField: string;
+            seriesField: string;
+        };
+    };
+}

package/dist/client/chart/g2plot/dualAxes.d.ts

@@ -0,0 +1,20 @@
+import { ISchema } from '@formily/react';
+import { G2PlotChart } from './g2plot';
+import { RenderProps } from '../chart';
+import React from 'react';
+import { FieldOption } from '../../hooks';
+import { QueryProps } from '../../renderer';
+export declare class DualAxes extends G2PlotChart {
+    schema: ISchema;
+    constructor();
+    init(fields: FieldOption[], { measures, dimensions, }: {
+        measures?: QueryProps['measures'];
+        dimensions?: QueryProps['dimensions'];
+    }): {
+        general: {
+            xField: string;
+            yField: string[];
+        };
+    };
+    render({ data, general, advanced, fieldProps }: RenderProps): () => React.FunctionComponentElement<any>;
+}

package/dist/client/chart/g2plot/g2plot.d.ts

@@ -0,0 +1,19 @@
+import { Chart, RenderProps } from '../chart';
+import { FieldOption } from '../../hooks';
+import { QueryProps } from '../../renderer';
+import { ISchema } from '@formily/react';
+export declare class G2PlotChart extends Chart {
+    schema: ISchema;
+    init(fields: FieldOption[], { measures, dimensions, }: {
+        measures?: QueryProps['measures'];
+        dimensions?: QueryProps['dimensions'];
+    }): {
+        general?: any;
+        advanced?: any;
+    };
+    getProps({ data, general, advanced, fieldProps }: RenderProps): any;
+    getReference(): {
+        title: string;
+        link: string;
+    };
+}

package/dist/client/chart/g2plot/index.d.ts

@@ -0,0 +1,6 @@
+import { Bar } from './bar';
+import { Pie } from './pie';
+import { DualAxes } from './dualAxes';
+import { G2PlotChart } from './g2plot';
+declare const _default: (G2PlotChart | Bar | Pie | DualAxes)[];
+export default _default;

package/dist/client/chart/g2plot/pie.d.ts

@@ -0,0 +1,17 @@
+import { ISchema } from '@formily/react';
+import { G2PlotChart } from './g2plot';
+import { FieldOption } from '../../hooks';
+import { QueryProps } from '../../renderer';
+export declare class Pie extends G2PlotChart {
+    schema: ISchema;
+    constructor();
+    init(fields: FieldOption[], { measures, dimensions, }: {
+        measures?: QueryProps['measures'];
+        dimensions?: QueryProps['dimensions'];
+    }): {
+        general: {
+            colorField: string;
+            angleField: string;
+        };
+    };
+}

package/dist/client/chart/library.d.ts

@@ -0,0 +1,28 @@
+import React from 'react';
+import { ChartType } from './chart';
+export type ChartLibraries = {
+    [library: string]: {
+        enabled: boolean;
+        charts: ChartType[];
+    };
+};
+export declare const ChartLibraryContext: React.Context<ChartLibraries>;
+export declare const useCharts: () => {
+    [name: string]: ChartType;
+};
+export declare const useChartTypes: () => {
+    label: string;
+    children: {
+        key: string;
+        label: string;
+        value: string;
+    }[];
+}[];
+export declare const useDefaultChartType: () => string;
+export declare const useToggleChartLibrary: () => {
+    toggle: (library: string) => void;
+};
+export declare const ChartLibraryProvider: React.FC<{
+    name: string;
+    charts: ChartType[];
+}>;

package/{lib → dist}/client/hooks.d.ts

@@ -1,5 +1,6 @@
 import { ArrayField } from '@formily/core';
 import { ISchema } from '@formily/react';
+import { CollectionFieldOptions } from '@nocobase/client';
 import { ChartRendererProps } from './renderer';
 export type FieldOption = {
     value: string;
@@ -13,10 +14,13 @@ export type FieldOption = {
     target?: string;
     targetFields?: FieldOption[];
 };
-export declare const useFields: (collection?: string) => {
-    key: any;
+export declare const useFields: (collection?: string) => (CollectionFieldOptions & {
+    key: string;
+    label: string;
+    value: string;
+})[];
+export declare const useFieldsWithAssociation: (collection?: string) => ({
     label: any;
-    value: any;
     name?: any;
     collectionName?: string;
     sourceKey?: string;
@@ -50,12 +54,7 @@ export declare const useFields: (collection?: string) => {
         required?: string | boolean | string[];
         format?: string;
         $ref?: string;
-        $namespace?: string; /**
-         * useFieldTypes
-         * Get field types for using transformers
-         * Only supported types will be displayed
-         * Some interfaces and types will be mapped to supported types
-         */
+        $namespace?: string;
         definitions?: import("@formily/react").SchemaProperties<any, any, any, any, any, any, any, any>;
         properties?: import("@formily/react").SchemaProperties<any, any, any, any, any, any, any, any>;
         items?: import("@formily/react").SchemaItems<any, any, any, any, any, any, any, any>;
@@ -64,77 +63,12 @@ export declare const useFields: (collection?: string) => {
         additionalProperties?: import("@formily/react").Stringify<any>;
         "x-value"?: any;
         "x-index"?: number;
-        "x-pattern"?: any;
-        "x-display"?: any;
-        "x-validator"?: any;
-        "x-decorator"?: any;
-        "x-decorator-props"?: any;
-        "x-component"?: any;
-        "x-component-props"?: any;
-        "x-reactions"?: import("@formily/react").SchemaReactions<any>;
-        "x-content"?: any;
-        "x-data"?: any;
-        "x-visible"?: boolean;
-        "x-hidden"?: boolean;
-        "x-disabled"?: boolean;
-        "x-editable"?: boolean;
-        "x-read-only"?: boolean;
-        "x-read-pretty"?: boolean;
-        "x-compile-omitted"?: string[];
-    }>;
-    target?: string;
-}[];
-export declare const useFieldsWithAssociation: (collection?: string) => ({
-    label: any;
-    key: any;
-    value: any;
-    name?: any;
-    collectionName?: string;
-    sourceKey?: string;
-    uiSchema?: import("@formily/react").Stringify<{
-        [key: symbol]: any;
-        [key: `x-${string}`]: any;
-        [key: `x-${number}`]: any;
-        version?: string;
-        name?: import("@formily/react").SchemaKey;
-        title?: any;
-        description?: any;
-        default?: any;
-        readOnly?: boolean;
-        writeOnly?: boolean;
-        type?: import("@formily/react").SchemaTypes;
-        enum?: import("@formily/react").SchemaEnum<any>;
-        const?: any;
-        multipleOf?: number;
-        maximum?: number;
-        exclusiveMaximum?: number;
-        minimum?: number;
-        exclusiveMinimum?: number;
-        maxLength?: number;
-        minLength?: number;
-        pattern?: string | RegExp;
-        maxItems?: number;
-        minItems?: number;
-        uniqueItems?: boolean;
-        maxProperties?: number;
-        minProperties?: number;
-        required?: string | boolean | string[];
-        format?: string;
-        $ref?: string;
-        $namespace?: string; /**
+        /**
          * useFieldTypes
          * Get field types for using transformers
          * Only supported types will be displayed
          * Some interfaces and types will be mapped to supported types
          */
-        definitions?: import("@formily/react").SchemaProperties<any, any, any, any, any, any, any, any>;
-        properties?: import("@formily/react").SchemaProperties<any, any, any, any, any, any, any, any>;
-        items?: import("@formily/react").SchemaItems<any, any, any, any, any, any, any, any>;
-        additionalItems?: import("@formily/react").Stringify<any>;
-        patternProperties?: import("@formily/react").SchemaProperties<any, any, any, any, any, any, any, any>;
-        additionalProperties?: import("@formily/react").Stringify<any>;
-        "x-value"?: any;
-        "x-index"?: number;
         "x-pattern"?: any;
         "x-display"?: any;
         "x-validator"?: any;
@@ -154,81 +88,11 @@ export declare const useFieldsWithAssociation: (collection?: string) => ({
         "x-compile-omitted"?: string[];
     }>;
     target?: string;
+    key: string;
+    value: string;
 } | {
     label: any;
-    targetFields: {
-        key: string;
-        label: string;
-        value: string;
-        name?: any;
-        collectionName?: string;
-        sourceKey?: string;
-        uiSchema?: import("@formily/react").Stringify<{
-            [key: symbol]: any;
-            [key: `x-${string}`]: any;
-            [key: `x-${number}`]: any;
-            version?: string;
-            name?: import("@formily/react").SchemaKey;
-            title?: any;
-            description?: any;
-            default?: any;
-            readOnly?: boolean;
-            writeOnly?: boolean;
-            type?: import("@formily/react").SchemaTypes;
-            enum?: import("@formily/react").SchemaEnum<any>;
-            const?: any;
-            multipleOf?: number;
-            maximum?: number;
-            exclusiveMaximum?: number;
-            minimum?: number;
-            exclusiveMinimum?: number;
-            maxLength?: number;
-            minLength?: number;
-            pattern?: string | RegExp;
-            maxItems?: number;
-            minItems?: number;
-            uniqueItems?: boolean;
-            maxProperties?: number;
-            minProperties?: number;
-            required?: string | boolean | string[];
-            format?: string;
-            $ref?: string;
-            $namespace?: string; /**
-             * useFieldTypes
-             * Get field types for using transformers
-             * Only supported types will be displayed
-             * Some interfaces and types will be mapped to supported types
-             */
-            definitions?: import("@formily/react").SchemaProperties<any, any, any, any, any, any, any, any>;
-            properties?: import("@formily/react").SchemaProperties<any, any, any, any, any, any, any, any>;
-            items?: import("@formily/react").SchemaItems<any, any, any, any, any, any, any, any>;
-            additionalItems?: import("@formily/react").Stringify<any>;
-            patternProperties?: import("@formily/react").SchemaProperties<any, any, any, any, any, any, any, any>;
-            additionalProperties?: import("@formily/react").Stringify<any>;
-            "x-value"?: any;
-            "x-index"?: number;
-            "x-pattern"?: any;
-            "x-display"?: any;
-            "x-validator"?: any;
-            "x-decorator"?: any;
-            "x-decorator-props"?: any;
-            "x-component"?: any;
-            "x-component-props"?: any;
-            "x-reactions"?: import("@formily/react").SchemaReactions<any>;
-            "x-content"?: any;
-            "x-data"?: any;
-            "x-visible"?: boolean;
-            "x-hidden"?: boolean;
-            "x-disabled"?: boolean;
-            "x-editable"?: boolean;
-            "x-read-only"?: boolean;
-            "x-read-pretty"?: boolean;
-            "x-compile-omitted"?: string[];
-        }>;
-        target?: string;
-    }[];
-    key: any;
-    value: any;
+    targetFields: any[];
     name?: any;
     collectionName?: string;
     sourceKey?: string;
@@ -262,12 +126,7 @@ export declare const useFieldsWithAssociation: (collection?: string) => ({
         required?: string | boolean | string[];
         format?: string;
         $ref?: string;
-        $namespace?: string; /**
-         * useFieldTypes
-         * Get field types for using transformers
-         * Only supported types will be displayed
-         * Some interfaces and types will be mapped to supported types
-         */
+        $namespace?: string;
         definitions?: import("@formily/react").SchemaProperties<any, any, any, any, any, any, any, any>;
         properties?: import("@formily/react").SchemaProperties<any, any, any, any, any, any, any, any>;
         items?: import("@formily/react").SchemaItems<any, any, any, any, any, any, any, any>;
@@ -276,6 +135,12 @@ export declare const useFieldsWithAssociation: (collection?: string) => ({
         additionalProperties?: import("@formily/react").Stringify<any>;
         "x-value"?: any;
         "x-index"?: number;
+        /**
+         * useFieldTypes
+         * Get field types for using transformers
+         * Only supported types will be displayed
+         * Some interfaces and types will be mapped to supported types
+         */
         "x-pattern"?: any;
         "x-display"?: any;
         "x-validator"?: any;
@@ -295,6 +160,8 @@ export declare const useFieldsWithAssociation: (collection?: string) => ({
         "x-compile-omitted"?: string[];
     }>;
     target?: string;
+    key: string;
+    value: string;
 })[];
 export declare const useChartFields: (fields: FieldOption[]) => (field: any) => void;
 export declare const useFormatters: (fields: FieldOption[]) => (field: any) => void;
@@ -310,3 +177,4 @@ export declare const useTransformers: (field: any) => void;
 export declare const useFieldTransformer: (transform: ChartRendererProps['transform'], locale?: string) => {};
 export declare const useOrderFieldsOptions: (defaultOptions: any[], fields: FieldOption[]) => (field: any) => void;
 export declare const useOrderReaction: (defaultOptions: any[], fields: FieldOption[]) => (field: ArrayField) => void;
+export declare const useData: (data?: any[], collection?: string) => {}[];

package/{lib → dist}/client/index.d.ts

@@ -1,7 +1,9 @@
 import { Plugin } from '@nocobase/client';
-import { ChartLibraryProvider } from './renderer/ChartLibrary';
+import { ChartLibraryProvider } from './chart/library';
 declare class DataVisualizationPlugin extends Plugin {
     load(): Promise<void>;
 }
 export default DataVisualizationPlugin;
 export { ChartLibraryProvider };
+export { Chart } from './chart/chart';
+export type { ChartType } from './chart/chart';