feat: add boxplot

Author: hustcc

__tests__/api.spec.ts

@@ -11,6 +11,7 @@ describe("sdk API", () => {
     expect(Object.keys(charts)).toEqual([
       "area",
       "bar",
+      "boxplot",
       "column",
       "dual-axes",
       "fishbone-diagram",

__tests__/charts/boxplot.json

@@ -0,0 +1,65 @@
+{
+  "name": "generate_boxplot_chart",
+  "description": "Generate a boxplot chart to show data for statistical summaries among different categories, such as, comparing the distribution of data points across categories.",
+  "inputSchema": {
+    "type": "object",
+    "properties": {
+      "data": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "category": {
+              "type": "string",
+              "description": "Category of the data point, such as '分类一'."
+            },
+            "value": {
+              "type": "number",
+              "description": "Value of the data point, such as 10."
+            },
+            "group": {
+              "type": "string",
+              "description": "Optional group for the data point, used for grouping in the boxplot."
+            }
+          },
+          "required": ["category", "value"]
+        },
+        "minItems": 1,
+        "description": "Data for boxplot chart, such as, [{ category: '分类一', value: 10 }] or [{ category: '分类二', value: 20, group: '组别一' }]."
+      },
+      "theme": {
+        "type": "string",
+        "enum": ["default", "academy"],
+        "default": "default",
+        "description": "Set the theme for the chart, optional, default is 'default'."
+      },
+      "width": {
+        "type": "number",
+        "default": 600,
+        "description": "Set the width of chart, default is 600."
+      },
+      "height": {
+        "type": "number",
+        "default": 400,
+        "description": "Set the height of chart, default is 400."
+      },
+      "title": {
+        "type": "string",
+        "default": "",
+        "description": "Set the title of chart."
+      },
+      "axisXTitle": {
+        "type": "string",
+        "default": "",
+        "description": "Set the x-axis title of chart."
+      },
+      "axisYTitle": {
+        "type": "string",
+        "default": "",
+        "description": "Set the y-axis title of chart."
+      }
+    },
+    "required": ["data"],
+    "$schema": "http://json-schema.org/draft-07/schema#"
+  }
+}

__tests__/charts/charts.spec.ts

@@ -12,6 +12,10 @@ describe("charts schema check", () => {
       const schema = actualCharts[chartName].tool;
       const rightChart = expectedCharts[chartName];
 
+      if (chartName === "boxplot") {
+        console.log(`Boxplot chart schema: ${JSON.stringify(schema, null, 2)}`);
+      }
+
       expect(schema).toEqual(rightChart);
     });
   }

__tests__/charts/index.ts

@@ -1,5 +1,6 @@
 export { default as area } from "./area.json";
 export { default as bar } from "./bar.json";
+export { default as boxplot } from "./boxplot.json";
 export { default as column } from "./column.json";
 export { default as "dual-axes" } from "./dual-axes.json";
 export { default as "fishbone-diagram" } from "./fishbone-diagram.json";

src/charts/boxplot.ts

@@ -0,0 +1,50 @@
+import { z } from "zod";
+import { zodToJsonSchema } from "../utils";
+import {
+  AxisXTitleSchema,
+  AxisYTitleSchema,
+  HeightSchema,
+  ThemeSchema,
+  TitleSchema,
+  WidthSchema,
+} from "./base";
+
+const data = z.object({
+  category: z
+    .string()
+    .describe("Category of the data point, such as '分类一'."),
+  value: z.number().describe("Value of the data point, such as 10."),
+  group: z
+    .string()
+    .optional()
+    .describe(
+      "Optional group for the data point, used for grouping in the boxplot.",
+    ),
+});
+
+const schema = {
+  data: z
+    .array(data)
+    .describe(
+      "Data for boxplot chart, such as, [{ category: '分类一', value: 10 }] or [{ category: '分类二', value: 20, group: '组别一' }].",
+    )
+    .nonempty({ message: "Boxplot chart data cannot be empty." }),
+  theme: ThemeSchema,
+  width: WidthSchema,
+  height: HeightSchema,
+  title: TitleSchema,
+  axisXTitle: AxisXTitleSchema,
+  axisYTitle: AxisYTitleSchema,
+};
+
+const tool = {
+  name: "generate_boxplot_chart",
+  description:
+    "Generate a boxplot chart to show data for statistical summaries among different categories, such as, comparing the distribution of data points across categories.",
+  inputSchema: zodToJsonSchema(schema),
+};
+
+export const boxplot = {
+  schema,
+  tool,
+};

src/charts/index.ts

@@ -3,6 +3,7 @@
  */
 export { area } from "./area";
 export { bar } from "./bar";
+export { boxplot } from "./boxplot";
 export { column } from "./column";
 export { dualAxes as "dual-axes" } from "./dual-axes";
 export { fishboneDiagram as "fishbone-diagram" } from "./fishbone-diagram";