plugin-knowledge-base 1.0.0

package/dist/server/resources/ai-knowledge-base.js

@@ -0,0 +1,168 @@
+/**
+ * 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 ai_knowledge_base_exports = {};
+__export(ai_knowledge_base_exports, {
+  default: () => ai_knowledge_base_default
+});
+module.exports = __toCommonJS(ai_knowledge_base_exports);
+async function checkKBPermission(ctx, filterByTk, action) {
+  var _a, _b;
+  const repo = ctx.db.getRepository("aiKnowledgeBases");
+  const record = await repo.findOne({ filterByTk });
+  if (!record) {
+    return true;
+  }
+  const data = record.toJSON();
+  const userId = (_b = (_a = ctx.auth) == null ? void 0 : _a.user) == null ? void 0 : _b.id;
+  const roles = ctx.state.currentRoles ?? [];
+  const isRoot = roles.includes("root");
+  if (isRoot) {
+    return true;
+  }
+  if (data.accessLevel === "BASIC") {
+    return data.ownerId === userId;
+  }
+  if (data.accessLevel === "PUBLIC") {
+    return false;
+  }
+  if (data.accessLevel === "SHARED") {
+    return false;
+  }
+  return false;
+}
+var ai_knowledge_base_default = {
+  name: "aiKnowledgeBase",
+  actions: {
+    async list(ctx, next) {
+      var _a, _b;
+      const repo = ctx.db.getRepository("aiKnowledgeBases");
+      const { filter = {}, fields, sort, page, pageSize } = ctx.action.params;
+      const userId = (_b = (_a = ctx.auth) == null ? void 0 : _a.user) == null ? void 0 : _b.id;
+      const roles = ctx.state.currentRoles ?? [];
+      const isRoot = roles.includes("root");
+      if (!isRoot) {
+        filter.$or = [
+          { accessLevel: "PUBLIC" },
+          ...userId ? [{ accessLevel: "BASIC", ownerId: userId }] : [],
+          ...roles.length ? [{ accessLevel: "SHARED", "allowedRoles.$anyOf": roles }] : []
+        ];
+      }
+      ctx.body = await repo.find({
+        filter,
+        fields,
+        sort: sort ?? ["-createdAt"],
+        limit: pageSize,
+        offset: page ? (page - 1) * (pageSize || 20) : 0,
+        appends: ["vectorStore"]
+      });
+      await next();
+    },
+    async get(ctx, next) {
+      var _a, _b, _c;
+      const { filterByTk } = ctx.action.params;
+      const repo = ctx.db.getRepository("aiKnowledgeBases");
+      const record = await repo.findOne({
+        filterByTk,
+        appends: ["vectorStore", "documents"]
+      });
+      if (record) {
+        const data = record.toJSON();
+        const userId = (_b = (_a = ctx.auth) == null ? void 0 : _a.user) == null ? void 0 : _b.id;
+        const roles = ctx.state.currentRoles ?? [];
+        const isRoot = roles.includes("root");
+        if (!isRoot) {
+          const hasAccess = data.accessLevel === "PUBLIC" || data.accessLevel === "BASIC" && data.ownerId === userId || data.accessLevel === "SHARED" && ((_c = data.allowedRoles) == null ? void 0 : _c.some((r) => roles.includes(r)));
+          if (!hasAccess) {
+            ctx.throw(403, "Access denied");
+            return;
+          }
+        }
+      }
+      ctx.body = record;
+      await next();
+    },
+    async create(ctx, next) {
+      var _a, _b;
+      const rawValues = ctx.action.params.values || {};
+      const values = rawValues.values || rawValues;
+      const repo = ctx.db.getRepository("aiKnowledgeBases");
+      const userId = (_b = (_a = ctx.auth) == null ? void 0 : _a.user) == null ? void 0 : _b.id;
+      const roles = ctx.state.currentRoles ?? [];
+      const isRoot = roles.includes("root");
+      if (values.accessLevel === "PUBLIC" && !isRoot) {
+        ctx.throw(403, "Only administrators can create public knowledge bases");
+        return;
+      }
+      if (values.accessLevel === "BASIC") {
+        values.ownerId = userId;
+      }
+      ctx.body = await repo.create({ values });
+      if (values.vectorStoreId) {
+        await ctx.db.sequelize.query(
+          `UPDATE "aiKnowledgeBases" SET "vectorStoreId" = $1 WHERE id = $2`,
+          { bind: [values.vectorStoreId, ctx.body.get("id")] }
+        );
+      }
+      await next();
+    },
+    async update(ctx, next) {
+      const { filterByTk } = ctx.action.params;
+      const rawValues = ctx.action.params.values || {};
+      const values = rawValues.values || rawValues;
+      const repo = ctx.db.getRepository("aiKnowledgeBases");
+      const allowed = await checkKBPermission(ctx, filterByTk, "update");
+      if (!allowed) {
+        ctx.throw(403, "You do not have permission to update this knowledge base");
+        return;
+      }
+      ctx.body = await repo.update({
+        filterByTk,
+        values
+      });
+      if (values.vectorStoreId) {
+        await ctx.db.sequelize.query(
+          `UPDATE "aiKnowledgeBases" SET "vectorStoreId" = $1 WHERE id = $2`,
+          { bind: [values.vectorStoreId, filterByTk] }
+        );
+      }
+      await next();
+    },
+    // Fix #3: destroy with permission checks
+    async destroy(ctx, next) {
+      const { filterByTk } = ctx.action.params;
+      const repo = ctx.db.getRepository("aiKnowledgeBases");
+      const allowed = await checkKBPermission(ctx, filterByTk, "destroy");
+      if (!allowed) {
+        ctx.throw(403, "You do not have permission to delete this knowledge base");
+        return;
+      }
+      await repo.destroy({ filterByTk });
+      ctx.body = { success: true };
+      await next();
+    }
+  }
+};

package/dist/server/resources/ai-vector-databases.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 ai_vector_databases_exports = {};
+__export(ai_vector_databases_exports, {
+  default: () => ai_vector_databases_default
+});
+module.exports = __toCommonJS(ai_vector_databases_exports);
+var ai_vector_databases_default = {
+  name: "aiVectorDatabase",
+  actions: {
+    async list(ctx, next) {
+      const { filter, fields, sort, page, pageSize } = ctx.action.params;
+      const repo = ctx.db.getRepository("aiVectorDatabases");
+      ctx.body = await repo.find({
+        filter,
+        fields,
+        sort: sort ?? ["-createdAt"],
+        limit: pageSize,
+        offset: page ? (page - 1) * (pageSize || 20) : 0
+      });
+      await next();
+    },
+    async get(ctx, next) {
+      const { filterByTk } = ctx.action.params;
+      const repo = ctx.db.getRepository("aiVectorDatabases");
+      ctx.body = await repo.findOne({ filterByTk });
+      await next();
+    },
+    async create(ctx, next) {
+      const rawValues = ctx.action.params.values || {};
+      const values = rawValues.values || rawValues;
+      const repo = ctx.db.getRepository("aiVectorDatabases");
+      ctx.body = await repo.create({ values });
+      await next();
+    },
+    async update(ctx, next) {
+      const { filterByTk } = ctx.action.params;
+      const rawValues = ctx.action.params.values || {};
+      const values = rawValues.values || rawValues;
+      const repo = ctx.db.getRepository("aiVectorDatabases");
+      ctx.body = await repo.update({
+        filterByTk,
+        values
+      });
+      await next();
+    },
+    async destroy(ctx, next) {
+      const { filterByTk } = ctx.action.params;
+      const repo = ctx.db.getRepository("aiVectorDatabases");
+      await repo.destroy({ filterByTk });
+      ctx.body = { success: true };
+      await next();
+    },
+    async test(ctx, next) {
+      const rawValues = ctx.action.params.values || {};
+      const values = rawValues.values || rawValues;
+      const { provider, connectParams } = values;
+      if (!provider || !connectParams) {
+        ctx.body = { success: false, error: "Provider and connectParams are required" };
+        await next();
+        return;
+      }
+      const kbPlugin = ctx.app.pm.get("@nocobase/plugin-knowledge-base");
+      if (!kbPlugin) {
+        ctx.body = { success: false, error: "Knowledge base plugin not found" };
+        await next();
+        return;
+      }
+      try {
+        const { Client } = require("pg");
+        const client = new Client({
+          host: connectParams.host,
+          port: connectParams.port || 5432,
+          user: connectParams.username,
+          password: connectParams.password,
+          database: connectParams.database
+        });
+        await client.connect();
+        await client.query("SELECT 1");
+        const extResult = await client.query(
+          "SELECT * FROM pg_available_extensions WHERE name = 'vector'"
+        );
+        await client.end();
+        if (extResult.rows.length === 0) {
+          ctx.body = {
+            success: false,
+            error: "pgvector extension is not available. Use pgvector/pgvector Docker image."
+          };
+        } else {
+          ctx.body = { success: true };
+        }
+      } catch (error) {
+        ctx.body = { success: false, error: error.message };
+      }
+      await next();
+    }
+  }
+};

package/dist/server/resources/ai-vector-stores.js

@@ -0,0 +1,95 @@
+/**
+ * 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 ai_vector_stores_exports = {};
+__export(ai_vector_stores_exports, {
+  default: () => ai_vector_stores_default
+});
+module.exports = __toCommonJS(ai_vector_stores_exports);
+var ai_vector_stores_default = {
+  name: "aiVectorStore",
+  actions: {
+    async list(ctx, next) {
+      const { filter, fields, sort, page, pageSize } = ctx.action.params;
+      const repo = ctx.db.getRepository("aiVectorStores");
+      ctx.body = await repo.find({
+        filter,
+        fields,
+        sort: sort ?? ["-createdAt"],
+        limit: pageSize,
+        offset: page ? (page - 1) * (pageSize || 20) : 0,
+        appends: ["vectorDatabase"]
+      });
+      await next();
+    },
+    async get(ctx, next) {
+      const { filterByTk } = ctx.action.params;
+      const repo = ctx.db.getRepository("aiVectorStores");
+      ctx.body = await repo.findOne({
+        filterByTk,
+        appends: ["vectorDatabase"]
+      });
+      await next();
+    },
+    async create(ctx, next) {
+      const rawValues = ctx.action.params.values || {};
+      const values = rawValues.values || rawValues;
+      const repo = ctx.db.getRepository("aiVectorStores");
+      ctx.body = await repo.create({ values });
+      if (values.vectorDatabaseId) {
+        await ctx.db.sequelize.query(
+          `UPDATE "aiVectorStores" SET "vectorDatabaseId" = $1 WHERE id = $2`,
+          { bind: [values.vectorDatabaseId, ctx.body.get("id")] }
+        );
+      }
+      await next();
+    },
+    async update(ctx, next) {
+      const { filterByTk } = ctx.action.params;
+      const rawValues = ctx.action.params.values || {};
+      const values = rawValues.values || rawValues;
+      const repo = ctx.db.getRepository("aiVectorStores");
+      ctx.body = await repo.update({
+        filterByTk,
+        values
+      });
+      if (values.vectorDatabaseId) {
+        await ctx.db.sequelize.query(
+          `UPDATE "aiVectorStores" SET "vectorDatabaseId" = $1 WHERE id = $2`,
+          { bind: [values.vectorDatabaseId, filterByTk] }
+        );
+      }
+      await next();
+    },
+    async destroy(ctx, next) {
+      const { filterByTk } = ctx.action.params;
+      const repo = ctx.db.getRepository("aiVectorStores");
+      await repo.destroy({ filterByTk });
+      ctx.body = { success: true };
+      await next();
+    }
+  }
+};

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "plugin-knowledge-base",
+  "displayName": "AI Knowledge Base",
+  "displayName.vi-VN": "Cơ sở tri thức AI",
+  "displayName.zh-CN": "AI 知识库",
+  "description": "Provides Knowledge Base management, Vector Store, Vector Database (PGVector), and RAG retrieval capabilities for AI Employees.",
+  "description.vi-VN": "Cung cấp quản lý Cơ sở tri thức, Vector Store, Vector Database (PGVector), và khả năng truy xuất RAG cho nhân viên AI.",
+  "description.zh-CN": "为 AI 员工提供知识库管理、向量存储、向量数据库 (PGVector) 和 RAG 检索功能。",
+  "version": "1.0.0",
+  "license": "Apache-2.0",
+  "main": "./dist/server/index.js",
+  "files": [
+    "dist",
+    "client.js",
+    "client.d.ts",
+    "server.js",
+    "server.d.ts",
+    "README.md"
+  ],
+  "dependencies": {
+    "pg": "^8.13.0"
+  },
+  "peerDependencies": {
+    "@nocobase/client": "2.x",
+    "@nocobase/server": "2.x",
+    "@nocobase/database": "2.x",
+    "@nocobase/plugin-ai": "2.x",
+    "@nocobase/plugin-file-manager": "2.x",
+    "@nocobase/test": "2.x",
+    "@langchain/community": "^1.1.0",
+    "@langchain/core": "^1.1.24",
+    "@langchain/textsplitters": "^0.1.0"
+  },
+  "keywords": [
+    "AI",
+    "knowledge-base",
+    "RAG",
+    "vector-store"
+  ]
+}

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');