plugin-build-guide-block 1.1.2 → 1.1.3

package/dist/externalVersion.js

@@ -1,26 +1,17 @@
-/**
- * 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.
- */
-
 module.exports = {
-  "@nocobase/client": "2.0.45",
+  "@nocobase/client": "2.0.46",
   "react": "18.2.0",
   "@formily/react": "2.3.7",
   "antd": "5.24.2",
   "react-i18next": "11.18.6",
   "@ant-design/icons": "5.6.1",
   "@formily/core": "2.3.7",
-  "@nocobase/server": "2.0.45",
-  "@nocobase/flow-engine": "2.0.45",
-  "@nocobase/actions": "2.0.45",
-  "@nocobase/database": "2.0.45",
-  "@nocobase/plugin-ai": "2.0.45",
-  "@nocobase/plugin-file-manager": "2.0.45",
+  "@nocobase/server": "2.0.46",
+  "@nocobase/flow-engine": "2.0.46",
+  "@nocobase/actions": "2.0.46",
+  "@nocobase/database": "2.0.46",
+  "@nocobase/plugin-ai": "2.0.46",
+  "@nocobase/plugin-file-manager": "2.0.46",
   "@langchain/core": "1.1.24",
   "axios": "1.7.7"
 };

package/dist/index.js

@@ -1,12 +1,3 @@
-/**
- * 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;

package/dist/locale/namespace.js

@@ -1,12 +1,3 @@
-/**
- * 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;

package/dist/locale/vi-VN.json

@@ -15,10 +15,18 @@
   "Actions": "Hành động",
   "Edit": "Sửa",
   "Edit space": "Sửa Space",
-  "Generated HTML": "HTML Đã tạo",
-  "Generated Markdown": "Markdown Đã tạo",
-  "Output format": "Định dạng đầu ra",
-  "Select Space": "Chọn Space",
+  "Generated HTML": "HTML Đã tạo",
+  "Generated Markdown": "Markdown Đã tạo",
+  "Output format": "Định dạng đầu ra",
+  "Target chapters": "Số chapter cần tạo",
+  "Chapter guidance": "Hướng dẫn chia chapter",
+  "Describe how the guide should be split into chapters": "Mô tả cách chia hướng dẫn thành các chapter",
+  "Build Phase": "Giai đoạn Build",
+  "Chapters": "Chapter",
+  "Breakdown Plan": "Kế hoạch chia nội dung",
+  "Contents": "Mục lục",
+  "No guide content available": "Chưa có nội dung hướng dẫn",
+  "Select Space": "Chọn Space",
   "Build Log": "Log quá trình Build",
   "Delete": "Xóa",
   "Saved successfully": "Lưu thành công",

package/dist/locale/zh-CN.json

@@ -15,10 +15,18 @@
   "Actions": "操作",
   "Edit": "编辑",
   "Edit space": "编辑空间",
-  "Generated HTML": "生成的 HTML",
-  "Generated Markdown": "生成的 Markdown",
-  "Output format": "输出格式",
-  "Select Space": "选择空间",
+  "Generated HTML": "生成的 HTML",
+  "Generated Markdown": "生成的 Markdown",
+  "Output format": "输出格式",
+  "Target chapters": "目标章节数",
+  "Chapter guidance": "章节拆分说明",
+  "Describe how the guide should be split into chapters": "描述应如何将指南拆分为章节",
+  "Build Phase": "构建阶段",
+  "Chapters": "章节",
+  "Breakdown Plan": "拆分计划",
+  "Contents": "目录",
+  "No guide content available": "暂无指南内容",
+  "Select Space": "选择空间",
   "Build Log": "构建日志",
   "Delete": "删除",
   "Saved successfully": "保存成功",

package/dist/server/actions/build.js

@@ -1,12 +1,3 @@
-/**
- * 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;
@@ -47,7 +38,7 @@ var import_path = __toESM(require("path"));
 var import_crypto = __toESM(require("crypto"));
 var import_marked = require("marked");
 const MAX_SOURCE_CHARS = 9e4;
-const MIN_CHAPTERS = 3;
+const MIN_CHAPTERS = 1;
 const MAX_CHAPTERS = 12;
 const DEFAULT_TARGET_CHAPTERS = 5;
 const SANITIZE_OPTIONS = {
@@ -192,6 +183,7 @@ function createFallbackPlan(guideTitle, targetChapterCount) {
   };
 }
 function normalizePlan(rawText, guideTitle, targetChapterCount) {
+  const targetCount = clampChapterCount(targetChapterCount);
   const cleanText = stripFence(rawText);
   const jsonStart = cleanText.indexOf("{");
   const jsonEnd = cleanText.lastIndexOf("}");
@@ -200,19 +192,25 @@ function normalizePlan(rawText, guideTitle, targetChapterCount) {
   try {
     parsed = JSON.parse(jsonText);
   } catch {
-    return createFallbackPlan(guideTitle, targetChapterCount);
+    return createFallbackPlan(guideTitle, targetCount);
   }
   const rawChapters = Array.isArray(parsed == null ? void 0 : parsed.chapters) ? parsed.chapters : [];
-  const chapters = rawChapters.slice(0, MAX_CHAPTERS).map((item, index) => ({
-    title: String((item == null ? void 0 : item.title) || `Section ${index + 1}`),
-    goal: (item == null ? void 0 : item.goal) ? String(item.goal) : "",
-    sourceHints: Array.isArray(item == null ? void 0 : item.sourceHints) ? item.sourceHints.map((hint) => String(hint)) : []
-  })).filter((item) => item.title);
-  if (chapters.length < MIN_CHAPTERS) {
-    return createFallbackPlan((parsed == null ? void 0 : parsed.title) ? String(parsed.title) : guideTitle, targetChapterCount);
-  }
+  const planTitle = (parsed == null ? void 0 : parsed.title) ? String(parsed.title) : guideTitle;
+  const fallbackPlan = createFallbackPlan(planTitle, targetCount);
+  const chapters = fallbackPlan.chapters.map((fallback, index) => {
+    const item = rawChapters[index];
+    if (!item) return fallback;
+    const title = typeof item === "string" ? item : item == null ? void 0 : item.title;
+    const goal = typeof item === "object" ? item == null ? void 0 : item.goal : void 0;
+    const sourceHints = typeof item === "object" && Array.isArray(item == null ? void 0 : item.sourceHints) ? item.sourceHints : void 0;
+    return {
+      title: String(title || fallback.title),
+      goal: goal ? String(goal) : fallback.goal,
+      sourceHints: sourceHints ? sourceHints.map((hint) => String(hint)) : fallback.sourceHints
+    };
+  });
   return {
-    title: (parsed == null ? void 0 : parsed.title) ? String(parsed.title) : guideTitle,
+    title: planTitle,
     chapters
   };
 }
@@ -247,8 +245,8 @@ Return ONLY valid JSON with this shape:
 }
 
 Rules:
-- Create exactly ${targetCount} chapters.
-- Each chapter must cover a distinct user goal. Do not collapse the guide into a single chapter.
+- Create exactly ${targetCount} chapter${targetCount === 1 ? "" : "s"}.
+- If more than one chapter is requested, each chapter must cover a distinct user goal.
 - Keep chapter titles user-facing and action-oriented.
 - Do not include markdown fences or explanations.
 

package/dist/server/actions/getHtml.js

@@ -1,12 +1,3 @@
-/**
- * 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;

package/dist/server/actions/getMarkdown.js

@@ -1,12 +1,3 @@
-/**
- * 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;

package/dist/server/collections/ai-build-guide-pages.js

@@ -1,12 +1,3 @@
-/**
- * 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;

package/dist/server/collections/ai-build-guide-spaces.js

@@ -1,12 +1,3 @@
-/**
- * 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;

package/dist/server/index.js

@@ -1,12 +1,3 @@
-/**
- * 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;

package/dist/server/plugin.js

@@ -1,12 +1,3 @@
-/**
- * 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;

package/package.json

@@ -5,7 +5,7 @@
   "displayName.zh-CN": "构建指南区块",
   "description": "Generate user guides, tutorials and help books from documents using AI, then render the result as a block (HTML or Markdown).",
   "description.vi-VN": "Tạo hướng dẫn người dùng, tutorial và help book từ tài liệu bằng AI, hiển thị kết quả dưới dạng block (HTML hoặc Markdown).",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "license": "Apache-2.0",
   "keywords": [
     "ai",

package/src/client/UserGuideBlock.tsx

@@ -128,7 +128,7 @@ const guideStyles = `
   .user-guide-shell {
     display: grid;
     grid-template-columns: minmax(0, 1fr);
-    max-width: 1180px;
+    max-width: 95%;
     margin: 0 auto;
   }
 
@@ -175,7 +175,7 @@ const guideStyles = `
   }
 
   .user-guide-content {
-    max-width: 920px;
+    max-width: 95%;
     margin: 0 auto;
     padding: 32px;
     color: rgba(0, 0, 0, 0.82);

package/src/client/UserGuideManager.tsx

@@ -12,25 +12,53 @@ import { createForm } from '@formily/core';
 import { useForm } from '@formily/react';
 import { App } from 'antd';
 import { useTranslation } from 'react-i18next';
-import { spacesSchema } from './schemas/spacesSchema';
+import {
+  DEFAULT_TARGET_CHAPTER_COUNT,
+  MAX_TARGET_CHAPTER_COUNT,
+  MIN_TARGET_CHAPTER_COUNT,
+  spacesSchema,
+} from './schemas/spacesSchema';
 import { LLMServiceSelect } from './components/LLMServiceSelect';
-import { ModelSelect } from './components/ModelSelect';
-import { StatusTag } from './components/StatusTag';
-import { BuildButton } from './components/BuildButton';
-
-export const UserGuideManager = () => {
-  const { t } = useTranslation();
-
-  const useCreateFormProps = () => {
-    const form = useMemo(() => createForm(), []);
-    return { form };
-  };
-
-  const useEditFormProps = () => {
-    const record = useCollectionRecordData();
-    const form = useMemo(() => createForm({ initialValues: record }), [record]);
-    return { form };
-  };
+import { ModelSelect } from './components/ModelSelect';
+import { StatusTag } from './components/StatusTag';
+import { BuildButton } from './components/BuildButton';
+
+const normalizeTargetChapterCount = (value: unknown) => {
+  const count = Number(value);
+  if (!Number.isFinite(count)) return DEFAULT_TARGET_CHAPTER_COUNT;
+  return Math.max(MIN_TARGET_CHAPTER_COUNT, Math.min(MAX_TARGET_CHAPTER_COUNT, Math.round(count)));
+};
+
+export const UserGuideManager = () => {
+  const { t } = useTranslation();
+
+  const useCreateFormProps = () => {
+    const form = useMemo(
+      () =>
+        createForm({
+          initialValues: {
+            targetChapterCount: DEFAULT_TARGET_CHAPTER_COUNT,
+          },
+        }),
+      [],
+    );
+    return { form };
+  };
+
+  const useEditFormProps = () => {
+    const record = useCollectionRecordData();
+    const form = useMemo(
+      () =>
+        createForm({
+          initialValues: {
+            ...record,
+            targetChapterCount: normalizeTargetChapterCount(record?.targetChapterCount),
+          },
+        }),
+      [record],
+    );
+    return { form };
+  };
 
   const useCancelActionProps = () => {
     const { setVisible } = useActionContext();
@@ -42,11 +70,12 @@ export const UserGuideManager = () => {
     };
   };
 
-  const normalizeValues = (values: any) => {
-    const { documents, ...rest } = values;
-    if (Array.isArray(documents)) {
-      rest.documents = documents.map((doc: any) => (typeof doc === 'object' && doc?.id ? { id: doc.id } : doc));
-    }
+  const normalizeValues = (values: any) => {
+    const { documents, ...rest } = values;
+    rest.targetChapterCount = normalizeTargetChapterCount(rest.targetChapterCount);
+    if (Array.isArray(documents)) {
+      rest.documents = documents.map((doc: any) => (typeof doc === 'object' && doc?.id ? { id: doc.id } : doc));
+    }
     return rest;
   };
 

package/src/client/schemas/spacesSchema.ts

@@ -1,3 +1,7 @@
+export const MIN_TARGET_CHAPTER_COUNT = 1;
+export const MAX_TARGET_CHAPTER_COUNT = 12;
+export const DEFAULT_TARGET_CHAPTER_COUNT = 5;
+
 export const spacesSchema = {
   type: 'void',
   name: 'ai-build-guide-spaces',
@@ -91,12 +95,12 @@ export const spacesSchema = {
                           type: 'number',
                           title: '{{t("Target chapters")}}',
                           required: true,
-                          default: 5,
+                          default: DEFAULT_TARGET_CHAPTER_COUNT,
                           'x-decorator': 'FormItem',
                           'x-component': 'InputNumber',
                           'x-component-props': {
-                            min: 3,
-                            max: 12,
+                            min: MIN_TARGET_CHAPTER_COUNT,
+                            max: MAX_TARGET_CHAPTER_COUNT,
                             precision: 0,
                             style: {
                               width: '100%',
@@ -310,11 +314,12 @@ export const spacesSchema = {
                                   type: 'number',
                                   title: '{{t("Target chapters")}}',
                                   required: true,
+                                  default: DEFAULT_TARGET_CHAPTER_COUNT,
                                   'x-decorator': 'FormItem',
                                   'x-component': 'InputNumber',
                                   'x-component-props': {
-                                    min: 3,
-                                    max: 12,
+                                    min: MIN_TARGET_CHAPTER_COUNT,
+                                    max: MAX_TARGET_CHAPTER_COUNT,
                                     precision: 0,
                                     style: {
                                       width: '100%',

package/src/locale/vi-VN.json

@@ -15,10 +15,18 @@
   "Actions": "Hành động",
   "Edit": "Sửa",
   "Edit space": "Sửa Space",
-  "Generated HTML": "HTML Đã tạo",
-  "Generated Markdown": "Markdown Đã tạo",
-  "Output format": "Định dạng đầu ra",
-  "Select Space": "Chọn Space",
+  "Generated HTML": "HTML Đã tạo",
+  "Generated Markdown": "Markdown Đã tạo",
+  "Output format": "Định dạng đầu ra",
+  "Target chapters": "Số chapter cần tạo",
+  "Chapter guidance": "Hướng dẫn chia chapter",
+  "Describe how the guide should be split into chapters": "Mô tả cách chia hướng dẫn thành các chapter",
+  "Build Phase": "Giai đoạn Build",
+  "Chapters": "Chapter",
+  "Breakdown Plan": "Kế hoạch chia nội dung",
+  "Contents": "Mục lục",
+  "No guide content available": "Chưa có nội dung hướng dẫn",
+  "Select Space": "Chọn Space",
   "Build Log": "Log quá trình Build",
   "Delete": "Xóa",
   "Saved successfully": "Lưu thành công",

package/src/locale/zh-CN.json

@@ -15,10 +15,18 @@
   "Actions": "操作",
   "Edit": "编辑",
   "Edit space": "编辑空间",
-  "Generated HTML": "生成的 HTML",
-  "Generated Markdown": "生成的 Markdown",
-  "Output format": "输出格式",
-  "Select Space": "选择空间",
+  "Generated HTML": "生成的 HTML",
+  "Generated Markdown": "生成的 Markdown",
+  "Output format": "输出格式",
+  "Target chapters": "目标章节数",
+  "Chapter guidance": "章节拆分说明",
+  "Describe how the guide should be split into chapters": "描述应如何将指南拆分为章节",
+  "Build Phase": "构建阶段",
+  "Chapters": "章节",
+  "Breakdown Plan": "拆分计划",
+  "Contents": "目录",
+  "No guide content available": "暂无指南内容",
+  "Select Space": "选择空间",
   "Build Log": "构建日志",
   "Delete": "删除",
   "Saved successfully": "保存成功",

package/src/server/actions/build.ts

@@ -13,7 +13,7 @@ import crypto from 'crypto';
 import { marked } from 'marked';
 
 const MAX_SOURCE_CHARS = 90000;
-const MIN_CHAPTERS = 3;
+const MIN_CHAPTERS = 1;
 const MAX_CHAPTERS = 12;
 const DEFAULT_TARGET_CHAPTERS = 5;
 
@@ -167,6 +167,7 @@ function createFallbackPlan(guideTitle: string, targetChapterCount: number): Gui
 }
 
 function normalizePlan(rawText: string, guideTitle: string, targetChapterCount: number): GuidePlan {
+  const targetCount = clampChapterCount(targetChapterCount);
   const cleanText = stripFence(rawText);
   const jsonStart = cleanText.indexOf('{');
   const jsonEnd = cleanText.lastIndexOf('}');
@@ -175,24 +176,27 @@ function normalizePlan(rawText: string, guideTitle: string, targetChapterCount:
   try {
     parsed = JSON.parse(jsonText);
   } catch {
-    return createFallbackPlan(guideTitle, targetChapterCount);
+    return createFallbackPlan(guideTitle, targetCount);
   }
   const rawChapters = Array.isArray(parsed?.chapters) ? parsed.chapters : [];
-  const chapters = rawChapters
-    .slice(0, MAX_CHAPTERS)
-    .map((item: any, index: number) => ({
-      title: String(item?.title || `Section ${index + 1}`),
-      goal: item?.goal ? String(item.goal) : '',
-      sourceHints: Array.isArray(item?.sourceHints) ? item.sourceHints.map((hint: any) => String(hint)) : [],
-    }))
-    .filter((item: GuidePlanItem) => item.title);
-
-  if (chapters.length < MIN_CHAPTERS) {
-    return createFallbackPlan(parsed?.title ? String(parsed.title) : guideTitle, targetChapterCount);
-  }
+  const planTitle = parsed?.title ? String(parsed.title) : guideTitle;
+  const fallbackPlan = createFallbackPlan(planTitle, targetCount);
+  const chapters = fallbackPlan.chapters.map((fallback, index) => {
+    const item = rawChapters[index];
+    if (!item) return fallback;
+    const title = typeof item === 'string' ? item : item?.title;
+    const goal = typeof item === 'object' ? item?.goal : undefined;
+    const sourceHints = typeof item === 'object' && Array.isArray(item?.sourceHints) ? item.sourceHints : undefined;
+
+    return {
+      title: String(title || fallback.title),
+      goal: goal ? String(goal) : fallback.goal,
+      sourceHints: sourceHints ? sourceHints.map((hint: any) => String(hint)) : fallback.sourceHints,
+    };
+  });
 
   return {
-    title: parsed?.title ? String(parsed.title) : guideTitle,
+    title: planTitle,
     chapters,
   };
 }
@@ -229,8 +233,8 @@ Return ONLY valid JSON with this shape:
 }
 
 Rules:
-- Create exactly ${targetCount} chapters.
-- Each chapter must cover a distinct user goal. Do not collapse the guide into a single chapter.
+- Create exactly ${targetCount} chapter${targetCount === 1 ? '' : 's'}.
+- If more than one chapter is requested, each chapter must cover a distinct user goal.
 - Keep chapter titles user-facing and action-oriented.
 - Do not include markdown fences or explanations.