@antv/gpt-vis 0.6.1 → 1.0.0-beta.2

package/dist/esm/gpt-vis/index.d.ts

@@ -0,0 +1,115 @@
+import type { VisualizationOptions } from '../types';
+import type { AreaConfig } from '../vis/area';
+import type { BarConfig } from '../vis/bar';
+import type { BoxplotConfig } from '../vis/boxplot';
+import type { ColumnConfig } from '../vis/column';
+import type { DualAxesConfig } from '../vis/dual-axes';
+import type { FishboneDiagramConfig } from '../vis/fishbone-diagram';
+import type { FlowDiagramConfig } from '../vis/flow-diagram';
+import type { FunnelConfig } from '../vis/funnel';
+import type { HistogramConfig } from '../vis/histogram';
+import type { IndentedTreeConfig } from '../vis/indented-tree';
+import type { LineConfig } from '../vis/line';
+import type { LiquidConfig } from '../vis/liquid';
+import type { MindmapConfig } from '../vis/mindmap';
+import type { NetworkGraphConfig } from '../vis/network-graph';
+import type { OrganizationChartConfig } from '../vis/organization-chart';
+import type { PieConfig } from '../vis/pie';
+import type { RadarConfig } from '../vis/radar';
+import type { SankeyConfig } from '../vis/sankey';
+import type { ScatterConfig } from '../vis/scatter';
+import type { SummaryConfig } from '../vis/summary';
+import type { TableConfig } from '../vis/table';
+import type { TreemapConfig } from '../vis/treemap';
+import type { VennConfig } from '../vis/venn';
+import type { ViolinConfig } from '../vis/violin';
+import type { WaterfallConfig } from '../vis/waterfall';
+import type { WordCloudConfig } from '../vis/word-cloud';
+/**
+ * Union type for all supported chart configurations
+ */
+export type GPTVisConfig = AreaConfig | BarConfig | BoxplotConfig | ColumnConfig | DualAxesConfig | FlowDiagramConfig | FunnelConfig | HistogramConfig | IndentedTreeConfig | LineConfig | LiquidConfig | MindmapConfig | NetworkGraphConfig | OrganizationChartConfig | PieConfig | RadarConfig | SankeyConfig | ScatterConfig | SummaryConfig | TableConfig | TreemapConfig | VennConfig | ViolinConfig | WaterfallConfig | WordCloudConfig | FishboneDiagramConfig;
+/**
+ * GPTVis is the unified API for all chart types.
+ * It provides a simple interface to render different types of visualizations.
+ *
+ * @example
+ * ```ts
+ * import { GPTVis } from '@antv/gpt-vis';
+ *
+ * const g = new GPTVis({
+ *   container: '#container',
+ *   width: 600,
+ *   height: 400,
+ *   theme: 'academy', // Optional theme
+ *   wrapper: true, // Enable wrapper with tabs and controls (default: false)
+ * });
+ *
+ * // Render with config object
+ * g.render({
+ *   type: 'pie',
+ *   data: [
+ *     { category: '分类一', value: 27 },
+ *     { category: '分类二', value: 25 },
+ *   ],
+ *   innerRadius: 0.6,
+ * });
+ *
+ * // Or render with syntax string
+ * g.render(`
+ * vis pie
+ * data
+ *   - category 分类一
+ *     value 27
+ *   - category 分类二
+ *     value 25
+ * innerRadius: 0.6
+ * `);
+ *
+ * g.destroy();
+ * ```
+ */
+export declare class GPTVis {
+    private options;
+    private currentChart;
+    private currentChartType;
+    private wrapperInstance;
+    /**
+     * Chart type registry mapping type strings to factory functions
+     */
+    private static readonly chartRegistry;
+    /**
+     * Constructor
+     * @param options - Visualization options containing container, dimensions, and optional theme
+     */
+    constructor(options: VisualizationOptions);
+    /**
+     * Render a chart based on the provided configuration or syntax string.
+     *
+     * @param config - Chart configuration object (with type field) or syntax string (starting with 'vis [type]')
+     *
+     * @example
+     * ```ts
+     * // With config object
+     * g.render({
+     *   type: 'pie',
+     *   data: [{ category: 'A', value: 30 }, { category: 'B', value: 70 }]
+     * });
+     *
+     * // With syntax string
+     * g.render(`
+     * vis pie
+     * data
+     *   - category A
+     *     value 30
+     *   - category B
+     *     value 70
+     * `);
+     * ```
+     */
+    render(config: string | Record<string, unknown>): void;
+    /**
+     * Destroy the current chart instance and clean up resources
+     */
+    destroy(): void;
+}

package/dist/esm/gpt-vis/index.js

@@ -0,0 +1,245 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : String(i); }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+import { isVisSyntax, parse } from "../syntax/parser";
+import { resolveContainer } from "../util/container";
+import { createVisWrapper } from "../vis-wrapper";
+import { Area } from "../vis/area";
+import { Bar } from "../vis/bar";
+import { Boxplot } from "../vis/boxplot";
+import { Column } from "../vis/column";
+import { DualAxes } from "../vis/dual-axes";
+import { FishboneDiagram } from "../vis/fishbone-diagram";
+import { FlowDiagram } from "../vis/flow-diagram";
+import { Funnel } from "../vis/funnel";
+import { Histogram } from "../vis/histogram";
+import { IndentedTree } from "../vis/indented-tree";
+import { Line } from "../vis/line";
+import { Liquid } from "../vis/liquid";
+import { Mindmap } from "../vis/mindmap";
+import { NetworkGraph } from "../vis/network-graph";
+import { OrganizationChart } from "../vis/organization-chart";
+import { Pie } from "../vis/pie";
+import { Radar } from "../vis/radar";
+import { Sankey } from "../vis/sankey";
+import { Scatter } from "../vis/scatter";
+import { Summary } from "../vis/summary";
+import { Table } from "../vis/table";
+import { Treemap } from "../vis/treemap";
+import { Venn } from "../vis/venn";
+import { Violin } from "../vis/violin";
+import { Waterfall } from "../vis/waterfall";
+import { WordCloud } from "../vis/word-cloud";
+
+/**
+ * Union type for all supported chart configurations
+ */
+
+/**
+ * Union type for all chart instances
+ */
+
+/**
+ * GPTVis is the unified API for all chart types.
+ * It provides a simple interface to render different types of visualizations.
+ *
+ * @example
+ * ```ts
+ * import { GPTVis } from '@antv/gpt-vis';
+ *
+ * const g = new GPTVis({
+ *   container: '#container',
+ *   width: 600,
+ *   height: 400,
+ *   theme: 'academy', // Optional theme
+ *   wrapper: true, // Enable wrapper with tabs and controls (default: false)
+ * });
+ *
+ * // Render with config object
+ * g.render({
+ *   type: 'pie',
+ *   data: [
+ *     { category: '分类一', value: 27 },
+ *     { category: '分类二', value: 25 },
+ *   ],
+ *   innerRadius: 0.6,
+ * });
+ *
+ * // Or render with syntax string
+ * g.render(`
+ * vis pie
+ * data
+ *   - category 分类一
+ *     value 27
+ *   - category 分类二
+ *     value 25
+ * innerRadius: 0.6
+ * `);
+ *
+ * g.destroy();
+ * ```
+ */
+export var GPTVis = /*#__PURE__*/function () {
+  /**
+   * Constructor
+   * @param options - Visualization options containing container, dimensions, and optional theme
+   */
+  function GPTVis(options) {
+    _classCallCheck(this, GPTVis);
+    _defineProperty(this, "options", void 0);
+    _defineProperty(this, "currentChart", null);
+    _defineProperty(this, "currentChartType", '');
+    _defineProperty(this, "wrapperInstance", null);
+    this.options = _objectSpread(_objectSpread({}, options), {}, {
+      container: resolveContainer(options.container)
+    });
+  }
+
+  /**
+   * Render a chart based on the provided configuration or syntax string.
+   *
+   * @param config - Chart configuration object (with type field) or syntax string (starting with 'vis [type]')
+   *
+   * @example
+   * ```ts
+   * // With config object
+   * g.render({
+   *   type: 'pie',
+   *   data: [{ category: 'A', value: 30 }, { category: 'B', value: 70 }]
+   * });
+   *
+   * // With syntax string
+   * g.render(`
+   * vis pie
+   * data
+   *   - category A
+   *     value 30
+   *   - category B
+   *     value 70
+   * `);
+   * ```
+   */
+  _createClass(GPTVis, [{
+    key: "render",
+    value: function render(config) {
+      var type = '';
+      var chartConfig;
+      // If config is a string, parse it as syntax
+      if (!isVisSyntax(config) && typeof config === 'string') {
+        // Parse the syntax string by `Summary` component directly
+        type = 'summary';
+        chartConfig = config;
+      } else {
+        // Otherwise, parse the config object or syntax string
+        chartConfig = typeof config === 'string' ? parse(config) : config;
+        type = chartConfig.type;
+      }
+      if (!type) {
+        throw new Error('Chart type is required. Please provide a "type" field in the config object or use syntax string starting with "vis [type]".');
+      }
+      if (!type) {
+        throw new Error('Chart type is required');
+      }
+      var chartFactory = GPTVis.chartRegistry[type];
+      if (!chartFactory) {
+        var availableTypes = Object.keys(GPTVis.chartRegistry).join(', ');
+        throw new Error("Unsupported chart type: \"".concat(type, "\". Available types: ").concat(availableTypes));
+      }
+
+      // Create or reuse wrapper
+      var chartContainer = this.options.container;
+      if (this.options.wrapper) {
+        if (!this.wrapperInstance) {
+          this.wrapperInstance = createVisWrapper(this.options.container, {
+            chartType: type,
+            syntax: config,
+            locale: this.options.locale || 'zh-CN'
+          });
+        } else {
+          this.wrapperInstance.update(config);
+        }
+        chartContainer = this.wrapperInstance.chartContainer;
+      }
+
+      // Reuse existing chart instance if the chart type hasn't changed
+      if (this.currentChart && this.currentChartType === type) {
+        this.currentChart.render(chartConfig);
+      } else {
+        // Destroy previous chart if type changed
+        if (this.currentChart) {
+          this.currentChart.destroy();
+        }
+
+        // Create chart options with the appropriate container and theme
+        var chartOptions = _objectSpread(_objectSpread({}, this.options), {}, {
+          container: chartContainer
+        });
+
+        // Create new chart instance and render
+        this.currentChart = chartFactory(chartOptions);
+        this.currentChartType = type;
+        this.currentChart.render(chartConfig);
+      }
+
+      // Set chart reference in wrapper if wrapper is enabled
+      if (this.wrapperInstance) {
+        this.wrapperInstance.setChartRef(this.currentChart);
+      }
+    }
+
+    /**
+     * Destroy the current chart instance and clean up resources
+     */
+  }, {
+    key: "destroy",
+    value: function destroy() {
+      if (this.currentChart) {
+        this.currentChart.destroy();
+        this.currentChart = null;
+        this.currentChartType = '';
+      }
+      if (this.wrapperInstance) {
+        this.wrapperInstance.destroy();
+        this.wrapperInstance = null;
+      }
+    }
+  }]);
+  return GPTVis;
+}();
+/**
+ * Chart type registry mapping type strings to factory functions
+ */
+_defineProperty(GPTVis, "chartRegistry", {
+  area: Area,
+  bar: Bar,
+  boxplot: Boxplot,
+  column: Column,
+  'dual-axes': DualAxes,
+  'flow-diagram': FlowDiagram,
+  funnel: Funnel,
+  histogram: Histogram,
+  'indented-tree': IndentedTree,
+  line: Line,
+  liquid: Liquid,
+  mindmap: Mindmap,
+  'network-graph': NetworkGraph,
+  'organization-chart': OrganizationChart,
+  pie: Pie,
+  radar: Radar,
+  sankey: Sankey,
+  scatter: Scatter,
+  summary: Summary,
+  table: Table,
+  treemap: Treemap,
+  venn: Venn,
+  violin: Violin,
+  waterfall: Waterfall,
+  'word-cloud': WordCloud,
+  'fishbone-diagram': FishboneDiagram
+});

package/dist/esm/index.d.ts

@@ -1,13 +1,57 @@
-/********** export chart **********/
-export * from './export';
-/********** export types **********/
-export * from './types';
-/********** export render **********/
-export * from './render';
-/********** export GPTVis **********/
-export { withChartCode, withDefaultChartCode } from './ChartCodeRender';
-export type { CodeBlockComponent, ErrorRender, WithChartCodeOptions } from './ChartCodeRender/type';
-export { default as ConfigProvider, type ConfigProviderProps } from './ConfigProvider';
-export { default as GPTVis, type GPTVisProps } from './GPTVis';
-export { default as GPTVisLite, useEventPublish, type GPTVisLiteProps } from './GPTVis/Lite';
-export { default as version } from './version';
+export { GPTVis } from './gpt-vis';
+export type { GPTVisConfig } from './gpt-vis';
+export { isVisSyntax, parse } from './syntax';
+export type { ParsedConfig } from './syntax';
+export type { VisualizationOptions } from './types';
+export { Area } from './vis/area';
+export type { AreaConfig, AreaDataItem } from './vis/area';
+export { Bar } from './vis/bar';
+export type { BarConfig, BarDataItem } from './vis/bar';
+export { Boxplot } from './vis/boxplot';
+export type { BoxplotConfig, BoxplotDataItem } from './vis/boxplot';
+export { Column } from './vis/column';
+export type { ColumnConfig, ColumnDataItem } from './vis/column';
+export { DualAxes } from './vis/dual-axes';
+export type { DualAxesConfig, DualAxesSeriesItem } from './vis/dual-axes';
+export { FishboneDiagram } from './vis/fishbone-diagram';
+export type { FishboneDiagramConfig, FishboneDiagramInstance, FishboneNode, } from './vis/fishbone-diagram';
+export { FlowDiagram } from './vis/flow-diagram';
+export type { FlowDiagramConfig } from './vis/flow-diagram';
+export { Funnel } from './vis/funnel';
+export type { FunnelConfig, FunnelDataItem } from './vis/funnel';
+export { Histogram } from './vis/histogram';
+export type { HistogramConfig } from './vis/histogram';
+export { IndentedTree } from './vis/indented-tree';
+export type { IndentedTreeConfig, IndentedTreeData, IndentedTreeInstance, } from './vis/indented-tree';
+export { Line } from './vis/line';
+export type { LineConfig, LineDataItem } from './vis/line';
+export { Liquid } from './vis/liquid';
+export type { LiquidConfig } from './vis/liquid';
+export { Mindmap } from './vis/mindmap';
+export type { MindMapProps, MindmapConfig, MindmapData } from './vis/mindmap';
+export { NetworkGraph } from './vis/network-graph';
+export type { NetworkGraphConfig, NetworkGraphData, NetworkGraphEdge, NetworkGraphNode, } from './vis/network-graph';
+export { OrganizationChart } from './vis/organization-chart';
+export type { OrganizationChartConfig, OrganizationChartData } from './vis/organization-chart';
+export { Pie } from './vis/pie';
+export type { PieConfig } from './vis/pie';
+export { Radar } from './vis/radar';
+export type { RadarConfig, RadarDataItem } from './vis/radar';
+export { Sankey } from './vis/sankey';
+export type { SankeyConfig, SankeyDataItem } from './vis/sankey';
+export { Scatter } from './vis/scatter';
+export type { ScatterConfig, ScatterDataItem } from './vis/scatter';
+export { Summary } from './vis/summary';
+export type { SummaryConfig } from './vis/summary';
+export { Table } from './vis/table';
+export type { TableConfig } from './vis/table';
+export { Treemap } from './vis/treemap';
+export type { TreemapConfig, TreemapDataItem } from './vis/treemap';
+export { Venn } from './vis/venn';
+export type { VennConfig, VennDataItem } from './vis/venn';
+export { Violin } from './vis/violin';
+export type { ViolinConfig, ViolinDataItem } from './vis/violin';
+export { Waterfall } from './vis/waterfall';
+export type { WaterfallConfig, WaterfallDataItem } from './vis/waterfall';
+export { WordCloud } from './vis/word-cloud';
+export type { WordCloudConfig, WordCloudDataItem } from './vis/word-cloud';

package/dist/esm/index.js

@@ -1,15 +1,28 @@
-/********** export chart **********/
-export * from "./export";
-
-/********** export types **********/
-export * from "./types";
-
-/********** export render **********/
-export * from "./render";
-
-/********** export GPTVis **********/
-export { withChartCode, withDefaultChartCode } from "./ChartCodeRender";
-export { default as ConfigProvider } from "./ConfigProvider";
-export { default as GPTVis } from "./GPTVis";
-export { default as GPTVisLite, useEventPublish } from "./GPTVis/Lite";
-export { default as version } from "./version";
+export { GPTVis } from "./gpt-vis";
+export { isVisSyntax, parse } from "./syntax";
+export { Area } from "./vis/area";
+export { Bar } from "./vis/bar";
+export { Boxplot } from "./vis/boxplot";
+export { Column } from "./vis/column";
+export { DualAxes } from "./vis/dual-axes";
+export { FishboneDiagram } from "./vis/fishbone-diagram";
+export { FlowDiagram } from "./vis/flow-diagram";
+export { Funnel } from "./vis/funnel";
+export { Histogram } from "./vis/histogram";
+export { IndentedTree } from "./vis/indented-tree";
+export { Line } from "./vis/line";
+export { Liquid } from "./vis/liquid";
+export { Mindmap } from "./vis/mindmap";
+export { NetworkGraph } from "./vis/network-graph";
+export { OrganizationChart } from "./vis/organization-chart";
+export { Pie } from "./vis/pie";
+export { Radar } from "./vis/radar";
+export { Sankey } from "./vis/sankey";
+export { Scatter } from "./vis/scatter";
+export { Summary } from "./vis/summary";
+export { Table } from "./vis/table";
+export { Treemap } from "./vis/treemap";
+export { Venn } from "./vis/venn";
+export { Violin } from "./vis/violin";
+export { Waterfall } from "./vis/waterfall";
+export { WordCloud } from "./vis/word-cloud";

package/dist/esm/syntax/index.d.ts

@@ -0,0 +1,2 @@
+export { isVisSyntax, parse } from './parser';
+export type { ParsedConfig } from './parser';

package/dist/esm/syntax/index.js

@@ -0,0 +1 @@
+export { isVisSyntax, parse } from "./parser";

package/dist/esm/syntax/parser.d.ts

@@ -0,0 +1,82 @@
+/**
+ * GPT-Vis Syntax Parser
+ *
+ * Parses a markdown-like syntax for visualization configurations.
+ *
+ * Syntax rules:
+ * - `vis [chartType]` - Defines the chart type (required first line)
+ * - `data` - Starts a data array section
+ * - `  - key value` - Array item with key-value pairs
+ * - `  - value` - Simple array item (for flat arrays like histogram data)
+ * - `  - "value with spaces"` - Quoted string item; single or double quotes both supported.
+ *                               Quotes are required when the value contains spaces; optional otherwise.
+ *                               Quoted values are never coerced to numbers or booleans.
+ * - `key: value` or `key value` - Top-level key-value pair
+ * - `style` - Starts a style object section
+ * - `palette` inside `style` uses array syntax with dash-prefixed items
+ * - `children` - Nested array for hierarchical data (mind-map, treemap, etc.)
+ *
+ * @example
+ * ```
+ * vis pie
+ * data
+ *   - category 分类一
+ *     value 27
+ *   - category 分类二
+ *     value 25
+ * innerRadius: 0.6
+ * style
+ *   backgroundColor #333
+ *   palette
+ *     - #ff5a5f
+ *     - #1fb6ff
+ *     - #13ce66
+ * ```
+ *
+ * @example Simple array (histogram)
+ * ```
+ * vis histogram
+ * data
+ *   - 78
+ *   - 88
+ *   - 60
+ * binNumber 5
+ * ```
+ *
+ * @example Quoted string values (values containing spaces)
+ * ```
+ * vis dual-axes
+ * categories
+ *   - "North America"
+ *   - '东南 亚'
+ *   - 欧洲
+ * ```
+ *
+ * @example Hierarchical data (mind-map)
+ * ```
+ * vis mind-map
+ * data
+ *   - name 项目计划
+ *     children
+ *       - name 研究阶段
+ *         children
+ *           - name 市场调研
+ *           - name 技术可行性分析
+ *       - name 开发阶段
+ * ```
+ */
+/**
+ * Parsed chart configuration result
+ */
+export interface ParsedConfig {
+    type: string;
+    [key: string]: unknown;
+}
+/**
+ * Parse the visualization syntax string into a configuration object
+ */
+export declare function parse(syntax: string): ParsedConfig;
+/**
+ * Check if a val is a valid visualization syntax
+ */
+export declare function isVisSyntax(input: any): boolean;