plugin-build-guide-block 1.0.1 → 1.0.3

package/src/client/schemas/spacesSchema.ts

@@ -0,0 +1,305 @@
+export const spacesSchema = {
+  type: 'object',
+  properties: {
+    page: {
+      type: 'void',
+      'x-component': 'Page',
+      'x-component-props': {
+        ghost: true,
+      },
+      properties: {
+        actions: {
+          type: 'void',
+          'x-component': 'ActionBar',
+          'x-component-props': {
+            style: {
+              marginBottom: 16,
+            },
+          },
+          properties: {
+            create: {
+              type: 'void',
+              'x-component': 'Action',
+              'x-component-props': {
+                type: 'primary',
+                title: '{{t("Create space")}}',
+                icon: 'PlusOutlined',
+              },
+              properties: {
+                drawer: {
+                  type: 'void',
+                  'x-component': 'Action.Drawer',
+                  'x-component-props': {
+                    title: '{{t("Create space")}}',
+                  },
+                  properties: {
+                    form: {
+                      type: 'void',
+                      'x-component': 'FormV2',
+                      'x-use-component-props': 'useCreateFormProps',
+                      properties: {
+                        title: {
+                          type: 'string',
+                          title: '{{t("Title")}}',
+                          required: true,
+                          'x-decorator': 'FormItem',
+                          'x-component': 'Input',
+                        },
+                        llmService: {
+                          type: 'string',
+                          title: '{{t("LLM Service")}}',
+                          required: true,
+                          'x-decorator': 'FormItem',
+                          'x-component': 'LLMServiceSelect',
+                        },
+                        model: {
+                          type: 'string',
+                          title: '{{t("Model")}}',
+                          required: true,
+                          'x-decorator': 'FormItem',
+                          'x-component': 'ModelSelect',
+                          'x-reactions': {
+                            dependencies: ['llmService'],
+                            fulfill: {
+                              state: {
+                                value: '{{$deps[0] ? $self.value : undefined}}'
+                              }
+                            }
+                          }
+                        },
+                        systemPrompt: {
+                          type: 'string',
+                          title: '{{t("System Prompt")}}',
+                          'x-decorator': 'FormItem',
+                          'x-component': 'Input.TextArea',
+                          'x-component-props': {
+                            rows: 4,
+                          },
+                          default: 'You are an expert technical writer. Please generate a comprehensive HTML user guide based on the provided documents. Ensure the output is valid HTML and does not include Markdown syntax like ```html blocks.',
+                        },
+                        documents: {
+                          type: 'array',
+                          title: '{{t("Documents")}}',
+                          'x-decorator': 'FormItem',
+                          'x-component': 'Upload.Attachment',
+                          'x-component-props': {
+                            multiple: true,
+                            action: 'attachments:create',
+                            maxCount: 10,
+                          },
+                        },
+                        footer: {
+                          type: 'void',
+                          'x-component': 'Action.Drawer.Footer',
+                          properties: {
+                            cancel: {
+                              type: 'void',
+                              title: '{{t("Cancel")}}',
+                              'x-component': 'Action',
+                              'x-use-component-props': 'useCancelActionProps',
+                            },
+                            submit: {
+                              type: 'void',
+                              title: '{{t("Submit")}}',
+                              'x-component': 'Action',
+                              'x-use-component-props': 'useCreateActionProps',
+                            },
+                          },
+                        },
+                      },
+                    },
+                  },
+                },
+              },
+            },
+          },
+        },
+        table: {
+          type: 'array',
+          'x-decorator': 'TableBlockProvider',
+          'x-use-decorator-props': 'useTableBlockProps',
+          'x-component': 'TableV2',
+          'x-component-props': {
+            rowKey: 'id',
+            rowSelection: {
+              type: 'checkbox',
+            },
+          },
+          properties: {
+            title: {
+              type: 'void',
+              'x-decorator': 'TableV2.Column.Decorator',
+              'x-component': 'TableV2.Column',
+              properties: {
+                title: {
+                  type: 'string',
+                  'x-component': 'CollectionField',
+                  'x-read-pretty': true,
+                },
+              },
+            },
+            status: {
+              type: 'void',
+              'x-decorator': 'TableV2.Column.Decorator',
+              'x-component': 'TableV2.Column',
+              properties: {
+                status: {
+                  type: 'string',
+                  'x-component': 'StatusTag',
+                  'x-read-pretty': true,
+                },
+              },
+            },
+            buildLog: {
+              type: 'void',
+              'x-decorator': 'TableV2.Column.Decorator',
+              'x-component': 'TableV2.Column',
+              properties: {
+                buildLog: {
+                  type: 'string',
+                  'x-component': 'CollectionField',
+                  'x-read-pretty': true,
+                },
+              },
+            },
+            actions: {
+              type: 'void',
+              title: '{{t("Actions")}}',
+              'x-decorator': 'TableV2.Column.Decorator',
+              'x-component': 'TableV2.Column',
+              properties: {
+                actions: {
+                  type: 'void',
+                  'x-component': 'Space',
+                  'x-component-props': {
+                    split: '|',
+                  },
+                  properties: {
+                    build: {
+                      type: 'void',
+                      'x-component': 'BuildButton',
+                    },
+                    update: {
+                      type: 'void',
+                      title: '{{t("Edit")}}',
+                      'x-component': 'Action.Link',
+                      'x-component-props': {
+                        type: 'primary',
+                      },
+                      properties: {
+                        drawer: {
+                          type: 'void',
+                          'x-component': 'Action.Drawer',
+                          'x-component-props': {
+                            title: '{{t("Edit space")}}',
+                          },
+                          properties: {
+                            form: {
+                              type: 'void',
+                              'x-component': 'FormV2',
+                              'x-use-component-props': 'useEditFormProps',
+                              properties: {
+                                title: {
+                                  type: 'string',
+                                  title: '{{t("Title")}}',
+                                  required: true,
+                                  'x-decorator': 'FormItem',
+                                  'x-component': 'Input',
+                                },
+                                llmService: {
+                                  type: 'string',
+                                  title: '{{t("LLM Service")}}',
+                                  required: true,
+                                  'x-decorator': 'FormItem',
+                                  'x-component': 'LLMServiceSelect',
+                                },
+                                model: {
+                                  type: 'string',
+                                  title: '{{t("Model")}}',
+                                  required: true,
+                                  'x-decorator': 'FormItem',
+                                  'x-component': 'ModelSelect',
+                                },
+                                systemPrompt: {
+                                  type: 'string',
+                                  title: '{{t("System Prompt")}}',
+                                  'x-decorator': 'FormItem',
+                                  'x-component': 'Input.TextArea',
+                                  'x-component-props': {
+                                    rows: 4,
+                                  },
+                                },
+                                documents: {
+                                  type: 'array',
+                                  title: '{{t("Documents")}}',
+                                  'x-decorator': 'FormItem',
+                                  'x-component': 'Upload.Attachment',
+                                  'x-component-props': {
+                                    multiple: true,
+                                    action: 'attachments:create',
+                                    maxCount: 10,
+                                  },
+                                },
+                                generatedHtml: {
+                                  type: 'string',
+                                  title: '{{t("Generated HTML")}}',
+                                  'x-decorator': 'FormItem',
+                                  'x-component': 'Input.TextArea',
+                                  'x-component-props': {
+                                    rows: 6,
+                                  },
+                                  'x-read-pretty': true,
+                                },
+                                buildLog: {
+                                  type: 'string',
+                                  title: '{{t("Build Log")}}',
+                                  'x-decorator': 'FormItem',
+                                  'x-component': 'Input.TextArea',
+                                  'x-read-pretty': true,
+                                },
+                                footer: {
+                                  type: 'void',
+                                  'x-component': 'Action.Drawer.Footer',
+                                  properties: {
+                                    cancel: {
+                                      type: 'void',
+                                      title: '{{t("Cancel")}}',
+                                      'x-component': 'Action',
+                                      'x-use-component-props': 'useCancelActionProps',
+                                    },
+                                    submit: {
+                                      type: 'void',
+                                      title: '{{t("Submit")}}',
+                                      'x-component': 'Action',
+                                      'x-use-component-props': 'useUpdateActionProps',
+                                    },
+                                  },
+                                },
+                              },
+                            },
+                          },
+                        },
+                      },
+                    },
+                    delete: {
+                      type: 'void',
+                      title: '{{t("Delete")}}',
+                      'x-component': 'Action.Link',
+                      'x-use-component-props': 'useDestroyActionProps',
+                      'x-component-props': {
+                        confirm: {
+                          title: '{{t("Delete")}}',
+                          content: '{{t("Are you sure you want to delete this space?")}}',
+                        },
+                      },
+                    },
+                  },
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+};

package/src/index.ts

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

package/src/locale/en-US.json

@@ -0,0 +1,27 @@
+{
+  "Build Guide Block": "Build Guide Block",
+  "User guide block setting": "User guide block setting",
+  "Edit user guide settings": "Edit user guide settings",
+  "Space": "Space",
+  "User Guide": "User Guide",
+  "Create space": "Create space",
+  "Title": "Title",
+  "LLM Service": "LLM Service",
+  "Model": "Model",
+  "System Prompt": "System Prompt",
+  "Documents": "Documents",
+  "Cancel": "Cancel",
+  "Submit": "Submit",
+  "Actions": "Actions",
+  "Edit": "Edit",
+  "Edit space": "Edit space",
+  "Generated HTML": "Generated HTML",
+  "Build Log": "Build Log",
+  "Delete": "Delete",
+  "Saved successfully": "Saved successfully",
+  "Please select a User Guide Space in block settings": "Please select a User Guide Space in block settings",
+  "Build": "Build",
+  "Build started": "Build started",
+  "Build failed": "Build failed",
+  "Are you sure you want to delete this space?": "Are you sure you want to delete this space?"
+}

package/src/locale/vi-VN.json

@@ -0,0 +1,27 @@
+{
+  "Build Guide Block": "Block Hướng dẫn sử dụng",
+  "User guide block setting": "Cài đặt Block Hướng dẫn",
+  "Edit user guide settings": "Chỉnh sửa cài đặt",
+  "Space": "Không gian (Space)",
+  "User Guide": "Hướng dẫn sử dụng",
+  "Create space": "Tạo Space",
+  "Title": "Tiêu đề",
+  "LLM Service": "Dịch vụ LLM",
+  "Model": "Mô hình (Model)",
+  "System Prompt": "Prompt hệ thống",
+  "Documents": "Tài liệu",
+  "Cancel": "Hủy",
+  "Submit": "Xác nhận",
+  "Actions": "Hành động",
+  "Edit": "Sửa",
+  "Edit space": "Sửa Space",
+  "Generated HTML": "HTML Đã tạo",
+  "Build Log": "Log quá trình Build",
+  "Delete": "Xóa",
+  "Saved successfully": "Lưu thành công",
+  "Please select a User Guide Space in block settings": "Vui lòng chọn Space trong cài đặt block",
+  "Build": "Tạo",
+  "Build started": "Đã bắt đầu tạo",
+  "Build failed": "Tạo thất bại",
+  "Are you sure you want to delete this space?": "Bạn có chắc chắn muốn xóa Space này không?"
+}

package/src/locale/zh-CN.json

@@ -0,0 +1,27 @@
+{
+  "Build Guide Block": "生成指南区块",
+  "User guide block setting": "用户指南区块设置",
+  "Edit user guide settings": "编辑用户指南设置",
+  "Space": "空间",
+  "User Guide": "用户指南",
+  "Create space": "创建空间",
+  "Title": "标题",
+  "LLM Service": "大语言模型服务",
+  "Model": "模型",
+  "System Prompt": "系统提示词",
+  "Documents": "文档",
+  "Cancel": "取消",
+  "Submit": "提交",
+  "Actions": "操作",
+  "Edit": "编辑",
+  "Edit space": "编辑空间",
+  "Generated HTML": "生成的 HTML",
+  "Build Log": "构建日志",
+  "Delete": "删除",
+  "Saved successfully": "保存成功",
+  "Please select a User Guide Space in block settings": "请在区块设置中选择一个用户指南空间",
+  "Build": "构建",
+  "Build started": "构建已开始",
+  "Build failed": "构建失败",
+  "Are you sure you want to delete this space?": "确定要删除此空间吗？"
+}

package/src/server/actions/build.ts

@@ -0,0 +1,171 @@
+import { Context, Next } from '@nocobase/actions';
+import { Repository } from '@nocobase/database';
+import sanitizeHtml from 'sanitize-html';
+// @ts-ignore
+import { PluginAIServer } from '@nocobase/plugin-ai';
+// @ts-ignore
+import { PluginFileManagerServer } from '@nocobase/plugin-file-manager';
+import { HumanMessage, SystemMessage } from '@langchain/core/messages';
+import axios from 'axios';
+import fs from 'fs';
+import path from 'path';
+
+async function fetchFileContent(app: any, file: any): Promise<string> {
+  const fileManager = app.pm.get('file-manager') as PluginFileManagerServer;
+  if (!fileManager) return '';
+  const url = await fileManager.getFileURL(file);
+
+  try {
+    if (url.startsWith('http')) {
+      const response = await axios.get(url, { responseType: 'text', timeout: 15000 });
+      return response.data;
+    } else {
+      let localPath = url;
+      if (process.env.APP_PUBLIC_PATH && localPath.startsWith(process.env.APP_PUBLIC_PATH)) {
+        localPath = localPath.slice(process.env.APP_PUBLIC_PATH.length);
+      }
+      localPath = path.join(process.cwd(), localPath);
+      const data = await fs.promises.readFile(localPath, 'utf8');
+      return data;
+    }
+  } catch (err) {
+    app.log.error(`Failed to read file content for document ${file.id}`, err);
+    return `[Failed to read document: ${file.filename}]`;
+  }
+}
+
+export async function build(ctx: Context, next: Next) {
+  const { filterByTk } = ctx.action.params;
+  const repository = ctx.db.getRepository('aiBuildGuideSpaces') as Repository;
+
+  const space = await repository.findById(filterByTk);
+
+  if (!space) {
+    ctx.throw(404, 'Space not found');
+  }
+
+  // Capture the long-lived Application reference — NOT the per-request ctx
+  const app = ctx.app;
+  const db = ctx.db;
+
+  try {
+    // 1. Set status to building
+    await repository.update({
+      filterByTk,
+      values: {
+        status: 'building',
+        buildLog: null,
+      },
+    });
+
+    // 2. Run the LLM pipeline asynchronously (fire-and-forget)
+    const bgPromise = (async () => {
+      const bgRepo = db.getRepository('aiBuildGuideSpaces') as Repository;
+
+      // 2a. Extract Document contexts
+      const documents = await space.getDocuments();
+      let documentsText = '';
+
+      if (documents && documents.length > 0) {
+        const texts = await Promise.all(
+          documents.map(async (doc) => {
+            const content = await fetchFileContent(app, doc);
+            return `--- Document: ${doc.filename} ---\n${content}\n`;
+          })
+        );
+        documentsText = texts.join('\n');
+      }
+
+      // 2b. Connect to LLM via plugin-ai
+      const aiPlugin = app.pm.get('ai') as PluginAIServer;
+      if (!aiPlugin) {
+        throw new Error('Plugin AI is not available');
+      }
+
+      const { llmService, model, systemPrompt } = space.get();
+
+      if (!llmService || !model) {
+        throw new Error('LLM Service or model is missing in space configuration');
+      }
+
+      const serviceData = await aiPlugin.aiManager.getLLMService({ llmService, model });
+      const provider = serviceData.provider;
+
+      const messages = [];
+      if (systemPrompt) {
+        messages.push(new SystemMessage(systemPrompt));
+      }
+
+      const instruction = `Please generate an HTML user guide based on the following documents. Output ONLY valid HTML without Markdown blocks.\n\nDocuments:\n${documentsText}`;
+      messages.push(new HumanMessage(instruction));
+
+      const response = await provider.chatModel.invoke(messages);
+      let rawHtml = typeof response.content === 'string' ? response.content : JSON.stringify(response.content);
+
+      // Strip markdown code block if present
+      rawHtml = rawHtml.replace(/^```html\s*/, '').replace(/```\s*$/, '');
+
+      // 2c. Sanitize HTML output
+      const cleanHtml = sanitizeHtml(rawHtml, {
+        allowedTags: [
+          'div', 'p', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6',
+          'ul', 'ol', 'li', 'table', 'thead', 'tbody', 'tr', 'td', 'th',
+          'a', 'img', 'span', 'strong', 'em', 'code', 'pre', 'blockquote', 'br', 'hr'
+        ],
+        allowedAttributes: {
+          'a': ['href', 'target'],
+          'img': ['src', 'alt', 'width', 'height'],
+          '*': ['style', 'class']
+        },
+        allowedStyles: {
+          '*': {
+            'color': [/^\#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/, /^rgb/, /^rgba/],
+            'background-color': [/^\#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/, /^rgb/, /^rgba/],
+            'text-align': [/^left$/, /^right$/, /^center$/, /^justify$/],
+            'font-size': [/^\d+(?:px|em|%)$/]
+          }
+        }
+      });
+
+      // 2d. Save generated HTML
+      await bgRepo.update({
+        filterByTk,
+        values: {
+          generatedHtml: cleanHtml,
+          status: 'completed',
+        },
+      });
+    })();
+
+    // Ensure background errors are caught and persisted
+    bgPromise.catch(async (error) => {
+      app.log.error('Build Guide Background Error', error);
+      try {
+        const bgRepo = db.getRepository('aiBuildGuideSpaces') as Repository;
+        await bgRepo.update({
+          filterByTk,
+          values: {
+            status: 'error',
+            buildLog: error.message || String(error),
+          },
+        });
+      } catch (updateErr) {
+        app.log.error('Failed to persist build error status', updateErr);
+      }
+    });
+
+    ctx.body = { status: 'building' };
+  } catch (error) {
+    app.log.error('Build Guide Error', error);
+    await repository.update({
+      filterByTk,
+      values: {
+        status: 'error',
+        buildLog: error.message || String(error),
+      },
+    });
+    ctx.throw(500, error.message || 'Error occurred during build');
+  }
+
+  await next();
+}

package/src/server/actions/getHtml.ts

@@ -0,0 +1,26 @@
+import { Context, Next } from '@nocobase/actions';
+import { Repository } from '@nocobase/database';
+
+export async function getHtml(ctx: Context, next: Next) {
+  const { filterByTk } = ctx.action.params;
+  const { resourceName } = ctx.action;
+  const repository = ctx.db.getRepository<any>(resourceName) as Repository;
+  const model = await repository.findById(filterByTk);
+
+  if (!model) {
+    ctx.throw(404, 'User Guide not found');
+  }
+
+  if (model.get('status') !== 'completed') {
+    ctx.throw(400, 'User Guide is not ready yet');
+  }
+
+  ctx.body = model.get('generatedHtml') || '';
+  ctx.withoutDataWrapping = true;
+
+  ctx.set({
+    'Content-Type': 'text/html; charset=UTF-8',
+  });
+
+  await next();
+}

package/src/server/collections/ai-build-guide-spaces.ts

@@ -0,0 +1,49 @@
+import { defineCollection } from '@nocobase/database';
+
+export default defineCollection({
+  namespace: 'build-guide-block.ai-build-guide-spaces',
+  name: 'aiBuildGuideSpaces',
+  migrationRules: ['overwrite', 'schema-only'],
+  timestamps: true,
+  fields: [
+    {
+      type: 'uid',
+      name: 'id',
+      primaryKey: true,
+    },
+    {
+      type: 'string',
+      name: 'title',
+    },
+    {
+      type: 'string',
+      name: 'llmService',
+    },
+    {
+      type: 'string',
+      name: 'model',
+    },
+    {
+      type: 'text',
+      name: 'systemPrompt',
+    },
+    {
+      type: 'text',
+      name: 'generatedHtml',
+    },
+    {
+      type: 'string',
+      name: 'status',
+      defaultValue: 'draft',
+    },
+    {
+      type: 'text',
+      name: 'buildLog',
+    },
+    {
+      type: 'belongsToMany',
+      name: 'documents',
+      target: 'attachments',
+    },
+  ],
+});

package/src/server/index.ts

@@ -0,0 +1 @@
+export { default } from './plugin';