feat: add sankey

Author: hustcc

__tests__/api.spec.ts

@@ -24,6 +24,7 @@ describe("sdk API", () => {
       "organization-chart",
       "pie",
       "radar",
+      "sankey",
       "scatter",
       "treemap",
       "word-cloud",

__tests__/charts/index.ts

@@ -13,6 +13,7 @@ export { default as "network-graph" } from "./network-graph.json";
 export { default as "organization-chart" } from "./organization-chart.json";
 export { default as pie } from "./pie.json";
 export { default as radar } from "./radar.json";
+export { default as sankey } from "./sankey.json";
 export { default as scatter } from "./scatter.json";
 export { default as treemap } from "./treemap.json";
 export { default as "word-cloud" } from "./word-cloud.json";

__tests__/charts/sankey.json

@@ -0,0 +1,58 @@
+{
+  "name": "generate_sankey_chart",
+  "description": "Generate a sankey chart to visualize the flow of data between different stages or categories, such as, the user journey from landing on a page to completing a purchase.",
+  "inputSchema": {
+    "type": "object",
+    "properties": {
+      "data": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "source": {
+              "type": "string"
+            },
+            "target": {
+              "type": "string"
+            },
+            "value": {
+              "type": "number"
+            }
+          },
+          "required": ["source", "target", "value"]
+        },
+        "minItems": 1,
+        "description": "Date for sankey chart, such as, [{ source: 'Landing Page', target: 'Product Page', value: 50000 }, { source: 'Product Page', target: 'Add to Cart', value: 35000 }, { source: 'Add to Cart', target: 'Checkout', value: 25000 }, { source: 'Checkout', target: 'Payment', value: 15000 }, { source: 'Payment', target: 'Purchase Completed', value: 8000 }]."
+      },
+      "nodeAlign": {
+        "type": "string",
+        "enum": ["left", "right", "justify", "center"],
+        "default": "center",
+        "description": "Alignment of nodes in the sankey chart, such as, 'left', 'right', 'justify', or 'center'."
+      },
+      "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."
+      }
+    },
+    "required": ["data"],
+    "$schema": "http://json-schema.org/draft-07/schema#"
+  }
+}

src/charts/index.ts

@@ -16,6 +16,7 @@ export { networkGraph as "network-graph" } from "./network-graph";
 export { organizationChart as "organization-chart" } from "./organization-chart";
 export { pie } from "./pie";
 export { radar } from "./radar";
+export { sankey } from "./sankey";
 export { scatter } from "./scatter";
 export { treemap } from "./treemap";
 export { wordCloud as "word-cloud" } from "./word-cloud";

src/charts/sankey.ts

@@ -0,0 +1,41 @@
+import { z } from "zod";
+import { zodToJsonSchema } from "../utils";
+import { HeightSchema, ThemeSchema, TitleSchema, WidthSchema } from "./base";
+
+const data = z.object({
+  source: z.string(),
+  target: z.string(),
+  value: z.number(),
+});
+
+const schema = {
+  data: z
+    .array(data)
+    .describe(
+      "Date for sankey chart, such as, [{ source: 'Landing Page', target: 'Product Page', value: 50000 }, { source: 'Product Page', target: 'Add to Cart', value: 35000 }, { source: 'Add to Cart', target: 'Checkout', value: 25000 }, { source: 'Checkout', target: 'Payment', value: 15000 }, { source: 'Payment', target: 'Purchase Completed', value: 8000 }].",
+    )
+    .nonempty({ message: "Sankey chart data cannot be empty." }),
+  nodeAlign: z
+    .enum(["left", "right", "justify", "center"])
+    .optional()
+    .default("center")
+    .describe(
+      "Alignment of nodes in the sankey chart, such as, 'left', 'right', 'justify', or 'center'.",
+    ),
+  theme: ThemeSchema,
+  width: WidthSchema,
+  height: HeightSchema,
+  title: TitleSchema,
+};
+
+const tool = {
+  name: "generate_sankey_chart",
+  description:
+    "Generate a sankey chart to visualize the flow of data between different stages or categories, such as, the user journey from landing on a page to completing a purchase.",
+  inputSchema: zodToJsonSchema(schema),
+};
+
+export const sankey = {
+  schema,
+  tool,
+};