plugin-build-visualization-block 0.1.1

package/dist/server/tools/build-visualization-block.js

@@ -0,0 +1,130 @@
+/**
+ * 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.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var build_visualization_block_exports = {};
+__export(build_visualization_block_exports, {
+  default: () => build_visualization_block_default
+});
+module.exports = __toCommonJS(build_visualization_block_exports);
+var import_crypto = require("crypto");
+var import_zod = require("zod");
+var import_constants = require("../../shared/constants");
+var import_build = require("../actions/build");
+const buildVisualizationBlockSchema = import_zod.z.object({
+  requirement: import_zod.z.string().describe("Natural-language description of the visualization block to build."),
+  collections: import_zod.z.array(import_zod.z.string()).min(import_constants.MIN_COLLECTIONS).max(import_constants.MAX_COLLECTIONS).optional().describe("The selected target collection names the block should be built from."),
+  dataSource: import_zod.z.string().optional().describe("The data source key. Defaults to the main data source when omitted."),
+  llmService: import_zod.z.string().optional().describe("The AI/LLM service to use for generation."),
+  model: import_zod.z.string().optional().describe("The model to use for generation.")
+});
+function normalizeCollections(value) {
+  if (!Array.isArray(value)) {
+    return [];
+  }
+  return value.filter((item) => typeof item === "string" && item.length > 0).slice(0, import_constants.MAX_COLLECTIONS);
+}
+function normalizeOptionalString(value) {
+  return typeof value === "string" && value.trim() ? value.trim() : void 0;
+}
+function readRecordValue(record, key) {
+  if (!record) {
+    return void 0;
+  }
+  if (typeof record.get === "function") {
+    return record.get(key);
+  }
+  return record[key];
+}
+var build_visualization_block_default = {
+  groupName: "plugin-build-visualization",
+  tool: {
+    name: "build_visualization_block",
+    title: "Build Visualization Block",
+    description: "Generate a NocoBase chart/table/form block from a requirement and selected collections.",
+    execution: "backend",
+    schema: buildVisualizationBlockSchema,
+    invoke: async (ctx, args) => {
+      var _a, _b, _c;
+      try {
+        const { requirement } = args;
+        const { db } = ctx.app;
+        const settings = await db.getRepository(import_constants.SETTINGS_COLLECTION_NAME).findOne();
+        if (readRecordValue(settings, "enableAITool") === false) {
+          return { status: "error", content: "Build Visualization Block AI tool is disabled." };
+        }
+        const collections = ((_a = args.collections) == null ? void 0 : _a.length) ? args.collections : normalizeCollections(readRecordValue(settings, "defaultCollections"));
+        const dataSource = args.dataSource ?? normalizeOptionalString(readRecordValue(settings, "defaultDataSource"));
+        const llmService = args.llmService ?? normalizeOptionalString(readRecordValue(settings, "defaultLLMService"));
+        const model = args.model ?? normalizeOptionalString(readRecordValue(settings, "defaultModel"));
+        if (collections.length < import_constants.MIN_COLLECTIONS) {
+          return { status: "error", content: "At least one collection is required." };
+        }
+        if (!llmService || !model) {
+          return { status: "error", content: "AI service and model are required." };
+        }
+        const repo = db.getRepository(import_constants.COLLECTION_NAME);
+        const createdById = (_c = (_b = ctx.auth) == null ? void 0 : _b.user) == null ? void 0 : _c.id;
+        const runId = (0, import_crypto.randomUUID)();
+        const record = await repo.create({
+          values: {
+            requirement,
+            collections,
+            dataSource,
+            primaryCollection: collections[0],
+            llmService,
+            model,
+            status: "building",
+            buildPhase: "queued",
+            buildRunId: runId,
+            buildQueuedAt: /* @__PURE__ */ new Date(),
+            ...createdById !== void 0 ? { createdById } : {}
+          }
+        });
+        const id = record.get("id");
+        const buildId = String(id);
+        await (0, import_build.enqueueBuild)(ctx.app, {
+          buildId,
+          runId,
+          userId: createdById ?? null,
+          queuedAt: (/* @__PURE__ */ new Date()).toISOString()
+        });
+        return {
+          status: "success",
+          content: {
+            id,
+            collection: import_constants.COLLECTION_NAME,
+            status: "building",
+            buildPhase: "queued"
+          }
+        };
+      } catch (err) {
+        const message = err instanceof Error ? err.message : String(err);
+        ctx.app.logger.error(`[build_visualization_block] Error: ${message}`, err);
+        return { status: "error", content: message };
+      }
+    }
+  }
+};

package/dist/server/tools/index.js

@@ -0,0 +1,46 @@
+/**
+ * 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.
+ */
+
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var tools_exports = {};
+__export(tools_exports, {
+  buildVisualizationBlockTool: () => import_build_visualization_block.default
+});
+module.exports = __toCommonJS(tools_exports);
+var import_build_visualization_block = __toESM(require("./build-visualization-block"));
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  buildVisualizationBlockTool
+});

package/dist/shared/blockSpec.js

@@ -0,0 +1,76 @@
+/**
+ * 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.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var blockSpec_exports = {};
+__export(blockSpec_exports, {
+  blockSpecSchema: () => blockSpecSchema
+});
+module.exports = __toCommonJS(blockSpec_exports);
+var import_zod = require("zod");
+const aggregationSchema = import_zod.z.enum(["count", "sum", "avg", "max", "min"]);
+const chartMeasureSchema = import_zod.z.object({
+  field: import_zod.z.string(),
+  aggregation: aggregationSchema.optional(),
+  alias: import_zod.z.string(),
+  distinct: import_zod.z.boolean().optional()
+});
+const chartDimensionSchema = import_zod.z.object({
+  field: import_zod.z.string(),
+  alias: import_zod.z.string().optional(),
+  format: import_zod.z.string().optional()
+});
+const chartSpecItemSchema = import_zod.z.object({
+  key: import_zod.z.string(),
+  title: import_zod.z.string(),
+  chartType: import_zod.z.string(),
+  measures: import_zod.z.array(chartMeasureSchema),
+  dimensions: import_zod.z.array(chartDimensionSchema).optional(),
+  config: import_zod.z.record(import_zod.z.unknown()).optional()
+});
+const tableSpecSchema = import_zod.z.object({
+  fields: import_zod.z.array(import_zod.z.string()),
+  sortable: import_zod.z.array(import_zod.z.string()).optional(),
+  actions: import_zod.z.array(import_zod.z.enum(["view", "edit", "delete", "add"])).optional()
+});
+const formSpecSchema = import_zod.z.object({
+  fields: import_zod.z.array(import_zod.z.string()),
+  mode: import_zod.z.enum(["create", "edit"]).optional()
+});
+const blockSpecSchema = import_zod.z.object({
+  version: import_zod.z.literal(1),
+  blockType: import_zod.z.enum(["chart", "table", "form"]),
+  title: import_zod.z.string(),
+  primaryCollection: import_zod.z.string(),
+  dataSource: import_zod.z.string(),
+  charts: import_zod.z.array(chartSpecItemSchema).optional(),
+  table: tableSpecSchema.optional(),
+  form: formSpecSchema.optional(),
+  rationale: import_zod.z.string().optional()
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  blockSpecSchema
+});

package/dist/shared/constants.js

@@ -0,0 +1,67 @@
+/**
+ * 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.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var constants_exports = {};
+__export(constants_exports, {
+  ACTIONS: () => ACTIONS,
+  BUILD_PHASES: () => BUILD_PHASES,
+  BUILD_TIMEOUT_MS: () => BUILD_TIMEOUT_MS,
+  COLLECTION_NAME: () => COLLECTION_NAME,
+  LLM_TIMEOUT_MS: () => LLM_TIMEOUT_MS,
+  MAX_COLLECTIONS: () => MAX_COLLECTIONS,
+  MAX_REQUIREMENT_CHARS: () => MAX_REQUIREMENT_CHARS,
+  MIN_COLLECTIONS: () => MIN_COLLECTIONS,
+  PLUGIN_NAME: () => PLUGIN_NAME,
+  SETTINGS_COLLECTION_NAME: () => SETTINGS_COLLECTION_NAME
+});
+module.exports = __toCommonJS(constants_exports);
+const PLUGIN_NAME = "plugin-build-visualization-block";
+const COLLECTION_NAME = "aiVisualizationBuilds";
+const SETTINGS_COLLECTION_NAME = "aiVisualizationBuildSettings";
+const ACTIONS = {
+  build: "aiVisualizationBuilds:build",
+  retry: "aiVisualizationBuilds:retry",
+  getResult: "aiVisualizationBuilds:getResult"
+};
+const BUILD_PHASES = ["idle", "queued", "analyzing", "generating", "completed", "failed"];
+const MIN_COLLECTIONS = 1;
+const MAX_COLLECTIONS = 50;
+const MAX_REQUIREMENT_CHARS = 2e3;
+const LLM_TIMEOUT_MS = 6e4;
+const BUILD_TIMEOUT_MS = 30 * 60 * 1e3;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ACTIONS,
+  BUILD_PHASES,
+  BUILD_TIMEOUT_MS,
+  COLLECTION_NAME,
+  LLM_TIMEOUT_MS,
+  MAX_COLLECTIONS,
+  MAX_REQUIREMENT_CHARS,
+  MIN_COLLECTIONS,
+  PLUGIN_NAME,
+  SETTINGS_COLLECTION_NAME
+});

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "plugin-build-visualization-block",
+  "displayName": "Build Visualization Block",
+  "displayName.zh-CN": "构建可视化区块",
+  "displayName.vi-VN": "Khối tạo trực quan hóa",
+  "description": "Generate a NocoBase chart, table or form block from a natural-language requirement and selected collections using AI.",
+  "description.zh-CN": "使用 AI 根据自然语言需求和所选数据表生成 NocoBase 图表、表格或表单区块。",
+  "description.vi-VN": "Sử dụng AI để tạo khối biểu đồ, bảng hoặc biểu mẫu NocoBase từ yêu cầu bằng ngôn ngữ tự nhiên và các bộ sưu tập đã chọn.",
+  "version": "0.1.1",
+  "license": "Apache-2.0",
+  "main": "dist/server/index.js",
+  "keywords": [
+    "AI",
+    "Visualization",
+    "Block",
+    "NocoBase"
+  ],
+  "files": [
+    "dist",
+    "src",
+    "client.js",
+    "server.js",
+    "client.d.ts",
+    "server.d.ts",
+    "client-v2.js",
+    "client-v2.d.ts"
+  ],
+  "nocobase": {
+    "supportedVersions": [
+      "2.x"
+    ],
+    "editionLevel": 0
+  },
+  "peerDependencies": {
+    "@nocobase/client": "2.x",
+    "@nocobase/server": "2.x",
+    "@nocobase/plugin-ai": "2.x",
+    "@nocobase/plugin-data-visualization": "2.x",
+    "@langchain/core": "*",
+    "zod": "^3.x",
+    "@nocobase/client-v2": "2.x",
+    "@nocobase/flow-engine": "2.x"
+  }
+}

package/server.d.ts

@@ -0,0 +1,2 @@
+export * from './dist/server';
+export { default } from './dist/server';

package/server.js

@@ -0,0 +1 @@
+module.exports = require('./dist/server/index.js');