plugin-build-guide-block 1.1.3 → 1.1.4

package/dist/node_modules/zod/v4/package.json

@@ -0,0 +1,6 @@
+{ 
+  "type": "module",
+  "main": "./index.cjs",
+  "module": "./index.js",
+  "types": "./index.d.cts" 
+}

package/dist/node_modules/zod/v4-mini/index.cjs

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("../v4/mini/index.cjs"), exports);

package/dist/node_modules/zod/v4-mini/index.d.cts

@@ -0,0 +1 @@
+export * from "../v4/mini/index.cjs";

package/dist/node_modules/zod/v4-mini/index.d.ts

@@ -0,0 +1 @@
+export * from "../v4/mini/index.js";

package/dist/node_modules/zod/v4-mini/index.js

@@ -0,0 +1 @@
+export * from "../v4/mini/index.js";

package/dist/node_modules/zod/v4-mini/package.json

@@ -0,0 +1,6 @@
+{ 
+  "type": "module",
+  "main": "./index.cjs",
+  "module": "./index.js",
+  "types": "./index.d.cts" 
+}

package/dist/server/actions/build.js

@@ -1,3 +1,12 @@
+/**
+ * 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/actions/getHtml.js

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

@@ -4,6 +4,7 @@ export declare class PluginBuildGuideBlockServer extends Plugin {
     afterAdd(): void;
     beforeLoad(): void;
     load(): Promise<void>;
+    private registerAITools;
     private ensureCollectionSchema;
     private ensureSchema;
     install(options?: InstallOptions): Promise<void>;

package/dist/server/plugin.js

@@ -1,3 +1,12 @@
+/**
+ * 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;
@@ -26,6 +35,7 @@ var import_path = require("path");
 var import_build = require("./actions/build");
 var import_getHtml = require("./actions/getHtml");
 var import_getMarkdown = require("./actions/getMarkdown");
+var import_tools = require("./tools");
 class PluginBuildGuideBlockServer extends import_server.Plugin {
   schemaCollections = ["aiBuildGuideSpaces", "aiBuildGuidePages"];
   afterAdd() {
@@ -79,6 +89,36 @@ class PluginBuildGuideBlockServer extends import_server.Plugin {
         this.app.logger.warn("[plugin-build-guide-block] Failed to recover stale builds", err);
       }
     });
+    this.registerAITools();
+  }
+  registerAITools() {
+    var _a;
+    const toolsManager = (_a = this.app.aiManager) == null ? void 0 : _a.toolsManager;
+    if (!toolsManager) {
+      this.app.logger.warn("[plugin-build-guide-block] aiManager.toolsManager is not available; skipping tool registration");
+      return;
+    }
+    const tools = [import_tools.searchBuildGuidesTool];
+    toolsManager.registerTools(
+      tools.map((item) => {
+        const name = `${item.groupName}-${item.tool.name}`;
+        return {
+          scope: "CUSTOM",
+          defaultPermission: item.tool.execution === "backend" ? "ALLOW" : "ASK",
+          execution: item.tool.execution,
+          introduction: {
+            title: item.tool.title,
+            about: item.tool.description
+          },
+          definition: {
+            name,
+            description: item.tool.description,
+            schema: item.tool.schema
+          },
+          invoke: item.tool.invoke
+        };
+      })
+    );
   }
   async ensureCollectionSchema(collectionName) {
     const collection = this.db.getCollection(collectionName);

package/dist/server/tools/index.d.ts

@@ -0,0 +1 @@
+export { default as searchBuildGuidesTool } from './search-guides';

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, {
+  searchBuildGuidesTool: () => import_search_guides.default
+});
+module.exports = __toCommonJS(tools_exports);
+var import_search_guides = __toESM(require("./search-guides"));
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  searchBuildGuidesTool
+});

package/dist/server/tools/search-guides.d.ts

@@ -0,0 +1,28 @@
+import { z } from 'zod';
+declare const _default: {
+    groupName: string;
+    tool: {
+        name: string;
+        title: string;
+        description: string;
+        execution: string;
+        schema: z.ZodObject<{
+            action: z.ZodEnum<{
+                list_spaces: "list_spaces";
+                search_pages: "search_pages";
+                read_page: "read_page";
+            }>;
+            query: z.ZodOptional<z.ZodString>;
+            pageId: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>;
+        invoke: (args: {
+            action: string;
+            query?: string;
+            pageId?: string;
+        }, ctx: any) => Promise<{
+            status: string;
+            content: any;
+        }>;
+    };
+};
+export default _default;

package/dist/server/tools/search-guides.js

@@ -0,0 +1,122 @@
+/**
+ * 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 search_guides_exports = {};
+__export(search_guides_exports, {
+  default: () => search_guides_default
+});
+module.exports = __toCommonJS(search_guides_exports);
+var import_zod = require("zod");
+var search_guides_default = {
+  groupName: "plugin-build-guide",
+  tool: {
+    name: "search_build_guides",
+    title: "Search Build Guides",
+    description: "Search for available user guides, documentation, or read a specific guide page. Use this to help users find information in the build guide block.",
+    execution: "backend",
+    schema: import_zod.z.object({
+      action: import_zod.z.enum(["list_spaces", "search_pages", "read_page"]).describe("The action to perform: list_spaces (find available guide books), search_pages (search for pages across all or specific spaces), read_page (read the full content of a specific page)"),
+      query: import_zod.z.string().optional().describe("Search keyword for finding spaces or pages. Required for search_pages."),
+      pageId: import_zod.z.string().optional().describe("The ID of the page to read. Required for read_page.")
+    }),
+    invoke: async (args, ctx) => {
+      var _a;
+      const { action, query, pageId } = args;
+      const { db } = ctx.app;
+      const spaceRepo = db.getRepository("aiBuildGuideSpaces");
+      const pageRepo = db.getRepository("aiBuildGuidePages");
+      try {
+        if (action === "list_spaces") {
+          const spaces = await spaceRepo.find({
+            filter: query ? { title: { $iLike: `%${query}%` } } : {},
+            fields: ["id", "title", "chapterGuidance", "pageCount"],
+            limit: 20
+          });
+          return {
+            status: "success",
+            content: spaces.map((s) => ({
+              id: s.id,
+              title: s.title,
+              description: s.chapterGuidance,
+              pageCount: s.pageCount
+            }))
+          };
+        }
+        if (action === "search_pages") {
+          const pages = await pageRepo.find({
+            filter: query ? {
+              $or: [
+                { title: { $iLike: `%${query}%` } },
+                { goal: { $iLike: `%${query}%` } },
+                { generatedMarkdown: { $iLike: `%${query}%` } }
+              ]
+            } : {},
+            fields: ["id", "title", "slug", "goal", "spaceId"],
+            limit: 10,
+            appends: ["space(id,title)"]
+          });
+          return {
+            status: "success",
+            content: pages.map((p) => {
+              var _a2;
+              return {
+                id: p.id,
+                title: p.title,
+                goal: p.goal,
+                spaceName: (_a2 = p.space) == null ? void 0 : _a2.title
+              };
+            })
+          };
+        }
+        if (action === "read_page") {
+          if (!pageId) {
+            return { status: "error", content: "pageId is required for read_page action" };
+          }
+          const page = await pageRepo.findById(pageId, {
+            appends: ["space(id,title)"]
+          });
+          if (!page) {
+            return { status: "error", content: `Page with ID ${pageId} not found.` };
+          }
+          return {
+            status: "success",
+            content: {
+              id: page.id,
+              title: page.title,
+              spaceName: (_a = page.space) == null ? void 0 : _a.title,
+              goal: page.goal,
+              markdown: page.generatedMarkdown
+            }
+          };
+        }
+        return { status: "error", content: "Invalid action specified" };
+      } catch (err) {
+        ctx.app.logger.error(`[search_build_guides] Error: ${err.message}`, err);
+        return { status: "error", content: `Tool execution failed: ${err.message}` };
+      }
+    }
+  }
+};

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.3",
+  "version": "1.1.4",
   "license": "Apache-2.0",
   "keywords": [
     "ai",

package/src/client/models/UserGuideBlockModel.ts

@@ -3,23 +3,23 @@ import { escapeT } from '@nocobase/flow-engine';
 import React from 'react';
 import { UserGuideBlock } from '../UserGuideBlock';
 import { SpaceSelect } from '../components/SpaceSelect';
-
-export class UserGuideBlockModel extends BlockModel {
-  renderComponent() {
-    const { spaceId } = this.props;
-    return React.createElement(UserGuideBlock, { spaceId });
-  }
-}
-
-UserGuideBlockModel.registerFlow({
-  key: 'userGuideBlockSettings',
-  title: escapeT('User guide block setting', { ns: 'build-guide-block' }),
-  steps: {
-    editUserGuide: {
-      title: escapeT('Edit user guide settings', { ns: 'build-guide-block' }),
-      uiSchema(ctx) {
-        const t = ctx.t;
-        return {
+
+export class UserGuideBlockModel extends BlockModel {
+  renderComponent() {
+    const { spaceId } = (this as any).props || {};
+    return React.createElement(UserGuideBlock, { spaceId });
+  }
+}
+
+(UserGuideBlockModel as any).registerFlow({
+  key: 'userGuideBlockSettings',
+  title: escapeT('User guide block setting', { ns: 'build-guide-block' }),
+  steps: {
+    editUserGuide: {
+      title: escapeT('Edit user guide settings', { ns: 'build-guide-block' }),
+      uiSchema(ctx) {
+        const t = ctx.t;
+        return {
           spaceId: {
             title: t('Space'),
             type: 'string',
@@ -35,10 +35,10 @@ UserGuideBlockModel.registerFlow({
           spaceId,
         });
       },
-    },
-  },
-});
-
-UserGuideBlockModel.define({
-  label: escapeT('User Guide'),
-});
+    },
+  },
+});
+
+(UserGuideBlockModel as any).define({
+  label: escapeT('User Guide'),
+});

package/src/server/plugin.ts

@@ -3,6 +3,7 @@ import { resolve } from 'path';
 import { build } from './actions/build';
 import { getHtml } from './actions/getHtml';
 import { getMarkdown } from './actions/getMarkdown';
+import { searchBuildGuidesTool } from './tools';
 
 export class PluginBuildGuideBlockServer extends Plugin {
   private readonly schemaCollections = ['aiBuildGuideSpaces', 'aiBuildGuidePages'];
@@ -62,6 +63,38 @@ export class PluginBuildGuideBlockServer extends Plugin {
         this.app.logger.warn('[plugin-build-guide-block] Failed to recover stale builds', err);
       }
     });
+
+    this.registerAITools();
+  }
+
+  private registerAITools() {
+    const toolsManager = (this.app as any).aiManager?.toolsManager;
+    if (!toolsManager) {
+      this.app.logger.warn('[plugin-build-guide-block] aiManager.toolsManager is not available; skipping tool registration');
+      return;
+    }
+
+    const tools = [searchBuildGuidesTool];
+    toolsManager.registerTools(
+      tools.map((item: any) => {
+        const name = `${item.groupName}-${item.tool.name}`;
+        return {
+          scope: 'CUSTOM',
+          defaultPermission: item.tool.execution === 'backend' ? 'ALLOW' : 'ASK',
+          execution: item.tool.execution,
+          introduction: {
+            title: item.tool.title,
+            about: item.tool.description,
+          },
+          definition: {
+            name,
+            description: item.tool.description,
+            schema: item.tool.schema,
+          },
+          invoke: item.tool.invoke,
+        };
+      }),
+    );
   }
 
   private async ensureCollectionSchema(collectionName: string) {

package/src/server/tools/index.ts

@@ -0,0 +1 @@
+export { default as searchBuildGuidesTool } from './search-guides';

package/src/server/tools/search-guides.ts

@@ -0,0 +1,95 @@
+import { z } from 'zod';
+
+export default {
+  groupName: 'plugin-build-guide',
+  tool: {
+    name: 'search_build_guides',
+    title: 'Search Build Guides',
+    description: 'Search for available user guides, documentation, or read a specific guide page. Use this to help users find information in the build guide block.',
+    execution: 'backend',
+    schema: z.object({
+      action: z.enum(['list_spaces', 'search_pages', 'read_page']).describe('The action to perform: list_spaces (find available guide books), search_pages (search for pages across all or specific spaces), read_page (read the full content of a specific page)'),
+      query: z.string().optional().describe('Search keyword for finding spaces or pages. Required for search_pages.'),
+      pageId: z.string().optional().describe('The ID of the page to read. Required for read_page.'),
+    }),
+    invoke: async (args: { action: string; query?: string; pageId?: string }, ctx: any) => {
+      const { action, query, pageId } = args;
+      const { db } = ctx.app;
+
+      const spaceRepo = db.getRepository('aiBuildGuideSpaces');
+      const pageRepo = db.getRepository('aiBuildGuidePages');
+
+      try {
+        if (action === 'list_spaces') {
+          const spaces = await spaceRepo.find({
+            filter: query ? { title: { $iLike: `%${query}%` } } : {},
+            fields: ['id', 'title', 'chapterGuidance', 'pageCount'],
+            limit: 20,
+          });
+          return {
+            status: 'success',
+            content: spaces.map((s: any) => ({
+              id: s.id,
+              title: s.title,
+              description: s.chapterGuidance,
+              pageCount: s.pageCount,
+            })),
+          };
+        }
+
+        if (action === 'search_pages') {
+          const pages = await pageRepo.find({
+            filter: query
+              ? {
+                  $or: [
+                    { title: { $iLike: `%${query}%` } },
+                    { goal: { $iLike: `%${query}%` } },
+                    { generatedMarkdown: { $iLike: `%${query}%` } },
+                  ],
+                }
+              : {},
+            fields: ['id', 'title', 'slug', 'goal', 'spaceId'],
+            limit: 10,
+            appends: ['space(id,title)'],
+          });
+          return {
+            status: 'success',
+            content: pages.map((p: any) => ({
+              id: p.id,
+              title: p.title,
+              goal: p.goal,
+              spaceName: p.space?.title,
+            })),
+          };
+        }
+
+        if (action === 'read_page') {
+          if (!pageId) {
+            return { status: 'error', content: 'pageId is required for read_page action' };
+          }
+          const page = await pageRepo.findById(pageId, {
+            appends: ['space(id,title)'],
+          });
+          if (!page) {
+            return { status: 'error', content: `Page with ID ${pageId} not found.` };
+          }
+          return {
+            status: 'success',
+            content: {
+              id: page.id,
+              title: page.title,
+              spaceName: page.space?.title,
+              goal: page.goal,
+              markdown: page.generatedMarkdown,
+            },
+          };
+        }
+
+        return { status: 'error', content: 'Invalid action specified' };
+      } catch (err: any) {
+        ctx.app.logger.error(`[search_build_guides] Error: ${err.message}`, err);
+        return { status: 'error', content: `Tool execution failed: ${err.message}` };
+      }
+    },
+  },
+};