plugin-build-guide-block 1.0.10 → 1.0.12

package/dist/node_modules/sanitize-html/package.json

@@ -1 +1 @@
-{"name":"sanitize-html","version":"2.17.2","description":"Clean up user-submitted HTML, preserving allowlisted elements and allowlisted attributes on a per-element basis","sideEffects":false,"main":"index.js","files":["index.js"],"repository":{"type":"git","url":"https://github.com/apostrophecms/apostrophe.git","directory":"packages/sanitize-html"},"homepage":"https://github.com/apostrophecms/apostrophe/tree/main/packages/sanitize-html#readme","keywords":["html","parser","sanitizer","sanitize"],"author":"Apostrophe Technologies, Inc.","license":"MIT","dependencies":{"deepmerge":"^4.2.2","escape-string-regexp":"^4.0.0","htmlparser2":"^10.1.0","is-plain-object":"^5.0.0","parse-srcset":"^1.0.2","postcss":"^8.3.11"},"devDependencies":{"eslint":"^9.39.1","mocha":"^10.2.0","sinon":"^9.0.2","eslint-config-apostrophe":"^6.0.2"},"apostropheTestConfig":{"requiresMongo":false},"scripts":{"test":"npm run lint && mocha","lint":"eslint ."},"_lastModified":"2026-04-09T19:44:45.769Z"}
+{"name":"sanitize-html","version":"2.17.3","description":"Clean up user-submitted HTML, preserving allowlisted elements and allowlisted attributes on a per-element basis","sideEffects":false,"main":"index.js","files":["index.js"],"repository":{"type":"git","url":"https://github.com/apostrophecms/apostrophe.git","directory":"packages/sanitize-html"},"homepage":"https://github.com/apostrophecms/apostrophe/tree/main/packages/sanitize-html#readme","keywords":["html","parser","sanitizer","sanitize"],"author":"Apostrophe Technologies, Inc.","license":"MIT","dependencies":{"deepmerge":"^4.2.2","escape-string-regexp":"^4.0.0","htmlparser2":"^10.1.0","is-plain-object":"^5.0.0","parse-srcset":"^1.0.2","postcss":"^8.3.11"},"devDependencies":{"eslint":"^9.39.1","mocha":"^11.7.5","sinon":"^9.0.2","eslint-config-apostrophe":"^6.0.2"},"apostropheTestConfig":{"requiresMongo":false},"scripts":{"test":"npm run lint && mocha","lint":"eslint ."},"_lastModified":"2026-04-18T11:47:25.046Z"}

package/dist/server/actions/build.d.ts

@@ -0,0 +1,2 @@
+import { Context, Next } from '@nocobase/actions';
+export declare function build(ctx: Context, next: Next): Promise<void>;

package/dist/server/actions/build.js

@@ -44,6 +44,51 @@ var import_messages = require("@langchain/core/messages");
 var import_axios = __toESM(require("axios"));
 var import_fs = __toESM(require("fs"));
 var import_path = __toESM(require("path"));
+var import_marked = require("marked");
+const SANITIZE_OPTIONS = {
+  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|%)$/]
+    }
+  }
+};
 async function fetchFileContent(app, file) {
   const fileManager = app.pm.get("file-manager");
   if (!fileManager) return "";
@@ -105,7 +150,8 @@ ${content}
       if (!aiPlugin) {
         throw new Error("Plugin AI is not available");
       }
-      const { llmService, model, systemPrompt } = space.get();
+      const { llmService, model, systemPrompt, outputFormat } = space.get();
+      const format = outputFormat === "markdown" ? "markdown" : "html";
       if (!llmService || !model) {
         throw new Error("LLM Service or model is missing in space configuration");
       }
@@ -115,64 +161,32 @@ ${content}
       if (systemPrompt) {
         messages.push(new import_messages.SystemMessage(systemPrompt));
       }
-      const instruction = `Please generate an HTML user guide based on the following documents. Output ONLY valid HTML without Markdown blocks.
+      const instruction = format === "markdown" ? `Please generate a comprehensive user guide in pure Markdown based on the following documents. Output ONLY Markdown content (no HTML wrappers, no code-fence around the whole document).
+
+Documents:
+${documentsText}` : `Please generate an HTML user guide based on the following documents. Output ONLY valid HTML without Markdown blocks.
 
 Documents:
 ${documentsText}`;
       messages.push(new import_messages.HumanMessage(instruction));
       const response = await provider.chatModel.invoke(messages);
-      let rawHtml = typeof response.content === "string" ? response.content : JSON.stringify(response.content);
-      rawHtml = rawHtml.replace(/^```html\s*/, "").replace(/```\s*$/, "");
-      const cleanHtml = (0, import_sanitize_html.default)(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|%)$/]
-          }
-        }
-      });
+      const rawText = typeof response.content === "string" ? response.content : JSON.stringify(response.content);
+      const updateValues = { status: "completed" };
+      if (format === "markdown") {
+        const rawMarkdown = rawText.replace(/^```(?:markdown|md)?\s*/, "").replace(/```\s*$/, "");
+        const renderedHtml = await import_marked.marked.parse(rawMarkdown, { async: true });
+        const cleanHtml = (0, import_sanitize_html.default)(renderedHtml, SANITIZE_OPTIONS);
+        updateValues.generatedMarkdown = rawMarkdown;
+        updateValues.generatedHtml = cleanHtml;
+      } else {
+        const rawHtml = rawText.replace(/^```html\s*/, "").replace(/```\s*$/, "");
+        const cleanHtml = (0, import_sanitize_html.default)(rawHtml, SANITIZE_OPTIONS);
+        updateValues.generatedHtml = cleanHtml;
+        updateValues.generatedMarkdown = null;
+      }
       await bgRepo.update({
         filterByTk,
-        values: {
-          generatedHtml: cleanHtml,
-          status: "completed"
-        }
+        values: updateValues
       });
     })();
     bgPromise.catch(async (error) => {

package/dist/server/actions/getHtml.d.ts

@@ -0,0 +1,2 @@
+import { Context, Next } from '@nocobase/actions';
+export declare function getHtml(ctx: Context, next: Next): Promise<void>;

package/dist/server/actions/getMarkdown.d.ts

@@ -0,0 +1,2 @@
+import { Context, Next } from '@nocobase/actions';
+export declare function getMarkdown(ctx: Context, next: Next): Promise<void>;

package/dist/server/actions/getMarkdown.js

@@ -0,0 +1,53 @@
+/**
+ * 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 getMarkdown_exports = {};
+__export(getMarkdown_exports, {
+  getMarkdown: () => getMarkdown
+});
+module.exports = __toCommonJS(getMarkdown_exports);
+async function getMarkdown(ctx, next) {
+  const { filterByTk } = ctx.action.params;
+  const { resourceName } = ctx.action;
+  const repository = ctx.db.getRepository(resourceName);
+  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("generatedMarkdown") || "";
+  ctx.withoutDataWrapping = true;
+  ctx.set({
+    "Content-Type": "text/markdown; charset=UTF-8"
+  });
+  await next();
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getMarkdown
+});

package/dist/server/collections/ai-build-guide-spaces.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@nocobase/database").CollectionOptions;
+export default _default;

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

@@ -58,10 +58,19 @@ var ai_build_guide_spaces_default = (0, import_database.defineCollection)({
       type: "text",
       name: "systemPrompt"
     },
+    {
+      type: "string",
+      name: "outputFormat",
+      defaultValue: "html"
+    },
     {
       type: "text",
       name: "generatedHtml"
     },
+    {
+      type: "text",
+      name: "generatedMarkdown"
+    },
     {
       type: "string",
       name: "status",

package/dist/server/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from './plugin';
+export declare const namespace = "plugin-build-guide-block";

package/dist/server/index.js

@@ -14,8 +14,8 @@ var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
-  for (var name2 in all)
-    __defProp(target, name2, { get: all[name2], enumerable: true });
+  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") {
@@ -40,9 +40,8 @@ __export(server_exports, {
   namespace: () => namespace
 });
 module.exports = __toCommonJS(server_exports);
-var import_package = require("../../package.json");
 var import_plugin = __toESM(require("./plugin"));
-const namespace = import_package.name;
+const namespace = "plugin-build-guide-block";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   namespace

package/dist/server/plugin.d.ts

@@ -0,0 +1,12 @@
+import { InstallOptions, Plugin } from '@nocobase/server';
+export declare class PluginBuildGuideBlockServer extends Plugin {
+    afterAdd(): void;
+    beforeLoad(): void;
+    load(): Promise<void>;
+    install(options?: InstallOptions): Promise<void>;
+    upgrade(): Promise<void>;
+    afterEnable(): Promise<void>;
+    afterDisable(): Promise<void>;
+    remove(): Promise<void>;
+}
+export default PluginBuildGuideBlockServer;

package/dist/server/plugin.js

@@ -31,19 +31,26 @@ __export(plugin_exports, {
 });
 module.exports = __toCommonJS(plugin_exports);
 var import_server = require("@nocobase/server");
+var import_path = require("path");
 var import_build = require("./actions/build");
 var import_getHtml = require("./actions/getHtml");
+var import_getMarkdown = require("./actions/getMarkdown");
 class PluginBuildGuideBlockServer extends import_server.Plugin {
   afterAdd() {
   }
   beforeLoad() {
   }
   async load() {
+    await this.db.import({
+      directory: (0, import_path.resolve)(__dirname, "collections")
+    });
     this.app.resourceManager.registerActionHandlers({
       "aiBuildGuideSpaces:build": import_build.build,
-      "aiBuildGuideSpaces:getHtml": import_getHtml.getHtml
+      "aiBuildGuideSpaces:getHtml": import_getHtml.getHtml,
+      "aiBuildGuideSpaces:getMarkdown": import_getMarkdown.getMarkdown
     });
     this.app.acl.allow("aiBuildGuideSpaces", "getHtml", "loggedIn");
+    this.app.acl.allow("aiBuildGuideSpaces", "getMarkdown", "loggedIn");
     this.app.acl.registerSnippet({
       name: "pm.ai-build-guide",
       actions: [

package/package.json

@@ -1,31 +1,51 @@
-{
-  "name": "plugin-build-guide-block",
-  "version": "1.0.10",
-  "main": "dist/server/index.js",
-  "files": [
-    "dist",
-    "src",
-    "client.js",
-    "server.js",
-    "client.d.ts",
-    "server.d.ts"
-  ],
-  "dependencies": {
-    "dompurify": "^3.1.2",
-    "sanitize-html": "^2.13.0"
-  },
-  "devDependencies": {
-    "@types/dompurify": "^3.0.4",
-    "@types/sanitize-html": "^2.9.5"
-  },
-  "peerDependencies": {
-    "@nocobase/client": "2.x",
-    "@nocobase/server": "2.x",
-    "@nocobase/database": "2.x",
-    "@nocobase/test": "2.x",
-    "@nocobase/plugin-ai": "2.x",
-    "@nocobase/plugin-file-manager": "2.x",
-    "@langchain/core": "*",
-    "axios": "*"
-  }
-}
+{
+  "name": "plugin-build-guide-block",
+  "displayName": "Build Guide Block",
+  "displayName.vi-VN": "Khối tạo hướng dẫn",
+  "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.0.12",
+  "license": "Apache-2.0",
+  "keywords": [
+    "ai",
+    "guide",
+    "tutorial",
+    "documentation",
+    "nocobase-plugin"
+  ],
+  "main": "dist/server/index.js",
+  "files": [
+    "dist",
+    "src",
+    "client.js",
+    "server.js",
+    "client.d.ts",
+    "server.d.ts"
+  ],
+  "dependencies": {
+    "dompurify": "^3.1.2",
+    "marked": "^12.0.2",
+    "sanitize-html": "^2.13.0"
+  },
+  "devDependencies": {
+    "@types/dompurify": "^3.0.4",
+    "@types/sanitize-html": "^2.9.5"
+  },
+  "peerDependencies": {
+    "@nocobase/client": "2.x",
+    "@nocobase/server": "2.x",
+    "@nocobase/database": "2.x",
+    "@nocobase/test": "2.x",
+    "@nocobase/plugin-ai": "2.x",
+    "@nocobase/plugin-file-manager": "2.x",
+    "@langchain/core": "*",
+    "axios": "*"
+  },
+  "nocobase": {
+    "supportedVersions": [
+      "2.x"
+    ],
+    "editionLevel": 0
+  }
+}

package/src/client/UserGuideManager.tsx

@@ -9,6 +9,7 @@ import {
   useTableBlockProps,
 } from '@nocobase/client';
 import { createForm } from '@formily/core';
+import { useForm } from '@formily/react';
 import { App } from 'antd';
 import { useTranslation } from 'react-i18next';
 import { spacesSchema } from './schemas/spacesSchema';
@@ -54,11 +55,11 @@ export const UserGuideManager = () => {
     const { message } = App.useApp();
     const resource = useDataBlockResource();
     const { refresh } = useDataBlockRequest();
+    const form = useForm();
 
     return {
       type: 'primary',
       async onClick() {
-        const form = (this as any).form;
         try {
           await form.submit();
           await resource.create({ values: normalizeValues(form.values) });
@@ -80,11 +81,11 @@ export const UserGuideManager = () => {
     const resource = useDataBlockResource();
     const { refresh } = useDataBlockRequest();
     const record = useCollectionRecordData();
+    const form = useForm();
 
     return {
       type: 'primary',
       async onClick() {
-        const form = (this as any).form;
         try {
           await form.submit();
           await resource.update({

package/src/client/locale.ts

@@ -0,0 +1,18 @@
+import { useApp } from '@nocobase/client';
+import { useCallback } from 'react';
+import { name } from '../locale/namespace';
+
+export const namespace = name;
+
+export function useT() {
+  const app = useApp();
+  return useCallback(
+    (str: string, options?: any): string =>
+      app.i18n.t(str, { ns: [namespace, 'client'], ...options }) as unknown as string,
+    [app.i18n],
+  );
+}
+
+export function tStr(key: string) {
+  return `{{t(${JSON.stringify(key)}, { ns: ['${namespace}', 'client'], nsMode: 'fallback' })}}`;
+}

package/src/client/plugin.tsx

@@ -1,30 +1,52 @@
-import { Plugin } from '@nocobase/client';
-import { UserGuideManager } from './UserGuideManager';
-import { UserGuideBlockProvider } from './UserGuideBlockProvider';
-import { UserGuideBlockInitializer } from './UserGuideBlockInitializer';
-import { UserGuideBlockModel } from './models/UserGuideBlockModel';
-
-export class PluginBuildGuideBlockClient extends Plugin {
-  async load() {
-    this.app.pluginSettingsManager.add('ai-build-guide', {
-      icon: 'ReadOutlined',
-      title: '{{t("Build Guide Block", { ns: "build-guide-block" })}}',
-      Component: UserGuideManager,
-      aclSnippet: 'pm.ai-build-guide',
-    });
-
-    this.app.use(UserGuideBlockProvider);
-
-    const blocksInit = this.app.schemaInitializerManager.get('page:addBlock');
-    blocksInit?.add('otherBlocks.aiUserGuide', {
-      title: '{{t("User Guide", { ns: "build-guide-block" })}}',
-      Component: 'UserGuideBlockInitializer',
-    });
-
-    this.flowEngine.registerModels({
-      UserGuideBlockModel,
-    });
-  }
-}
-
-export default PluginBuildGuideBlockClient;
+import { Plugin, RemoteSelect } from '@nocobase/client';
+import { UserGuideManager } from './UserGuideManager';
+import { UserGuideBlockProvider } from './UserGuideBlockProvider';
+import { UserGuideBlockInitializer } from './UserGuideBlockInitializer';
+import { UserGuideBlock } from './UserGuideBlock';
+import { UserGuideBlockModel } from './models/UserGuideBlockModel';
+import { userGuideBlockSettings } from './schemaSettings';
+import { BuildButton } from './components/BuildButton';
+import { LLMServiceSelect } from './components/LLMServiceSelect';
+import { ModelSelect } from './components/ModelSelect';
+import { StatusTag } from './components/StatusTag';
+import { namespace } from './locale';
+
+export class PluginBuildGuideBlockClient extends Plugin {
+  async load() {
+    this.app.addComponents({
+      UserGuideBlock,
+      UserGuideBlockInitializer,
+      BuildButton,
+      LLMServiceSelect,
+      ModelSelect,
+      StatusTag,
+      RemoteSelect,
+    });
+
+    this.app.schemaSettingsManager.add(userGuideBlockSettings);
+
+    this.app.use(UserGuideBlockProvider);
+
+    this.app.pluginSettingsManager.add('ai-build-guide', {
+      icon: 'ReadOutlined',
+      title: `{{t("Build Guide Block", { ns: "${namespace}" })}}`,
+      Component: UserGuideManager,
+      aclSnippet: 'pm.ai-build-guide',
+    });
+
+    const initializerItem = {
+      title: `{{t("User Guide", { ns: "${namespace}" })}}`,
+      Component: 'UserGuideBlockInitializer',
+    };
+
+    this.app.schemaInitializerManager.addItem('page:addBlock', 'otherBlocks.aiUserGuide', initializerItem);
+    this.app.schemaInitializerManager.addItem('popup:common:addBlock', 'otherBlocks.aiUserGuide', initializerItem);
+    this.app.schemaInitializerManager.addItem('popup:addNew:addBlock', 'otherBlocks.aiUserGuide', initializerItem);
+
+    this.flowEngine.registerModels({
+      UserGuideBlockModel,
+    });
+  }
+}
+
+export default PluginBuildGuideBlockClient;

package/src/client/schemaSettings.ts

@@ -0,0 +1,75 @@
+import { useFieldSchema } from '@formily/react';
+import { SchemaSettings, useDesignable } from '@nocobase/client';
+import { useT } from './locale';
+
+export const userGuideBlockSettings = new SchemaSettings({
+  name: 'userGuideBlockSettings',
+  items: [
+    {
+      name: 'selectSpace',
+      type: 'modal',
+      useComponentProps() {
+        const fieldSchema = useFieldSchema();
+        const { dn } = useDesignable();
+        const t = useT();
+
+        const currentSpaceId = fieldSchema?.['x-component-props']?.spaceId || '';
+
+        return {
+          title: t('Select Space'),
+          schema: {
+            type: 'object',
+            properties: {
+              spaceId: {
+                title: t('Space'),
+                type: 'string',
+                'x-decorator': 'FormItem',
+                'x-component': 'RemoteSelect',
+                'x-component-props': {
+                  showSearch: true,
+                  fieldNames: { label: 'title', value: 'id' },
+                  service: {
+                    resource: 'aiBuildGuideSpaces',
+                    action: 'list',
+                    params: {
+                      filter: { status: 'completed' },
+                    },
+                  },
+                },
+                default: currentSpaceId,
+                required: true,
+              },
+            },
+          },
+          onSubmit({ spaceId }: { spaceId: string }) {
+            const componentProps = { ...fieldSchema['x-component-props'], spaceId };
+            fieldSchema['x-component-props'] = componentProps;
+            dn.emit('patch', {
+              schema: {
+                'x-uid': fieldSchema['x-uid'],
+                'x-component-props': componentProps,
+              },
+            });
+            dn.refresh();
+          },
+        };
+      },
+    },
+    {
+      name: 'divider',
+      type: 'divider',
+    },
+    {
+      name: 'delete',
+      type: 'remove',
+      useComponentProps() {
+        return {
+          removeParentsIfNoChildren: true,
+          breakRemoveOn: {
+            'x-component': 'Grid',
+          },
+        };
+      },
+    },
+  ],
+});