plugin-ai-api 1.0.1 → 1.0.3

package/dist/server/routes/completions.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;
@@ -67,16 +76,19 @@ async function handleCompletions(ctx, plugin) {
     }
     if (service.enabled === false) {
       ctx.status = 404;
-      ctx.body = (0, import_openai_format.toOpenAIError)(404, `LLM service '${service.title || service.name}' is disabled`, "invalid_request_error", "model_not_found");
+      ctx.body = (0, import_openai_format.toOpenAIError)(
+        404,
+        `LLM service '${service.title || service.name}' is disabled`,
+        "invalid_request_error",
+        "model_not_found"
+      );
       return;
     }
     const config = await ctx.db.getRepository("aiApiConfig").findOne();
     if ((_a = config == null ? void 0 : config.enabledLlmServices) == null ? void 0 : _a.length) {
       const serviceName = service.name;
       const serviceTitle = service.title;
-      const isAllowed = config.enabledLlmServices.some(
-        (s) => s === serviceName || s === serviceTitle
-      );
+      const isAllowed = config.enabledLlmServices.some((s) => s === serviceName || s === serviceTitle);
       if (!isAllowed) {
         ctx.status = 403;
         ctx.body = (0, import_openai_format.toOpenAIError)(

package/dist/server/routes/embeddings.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;
@@ -95,9 +104,7 @@ async function handleEmbeddings(ctx, plugin) {
   try {
     const config = await ctx.db.getRepository("aiApiConfig").findOne();
     if ((_a = config == null ? void 0 : config.enabledLlmServices) == null ? void 0 : _a.length) {
-      const allowed = config.enabledLlmServices.some(
-        (s) => s === service.name || s === service.title
-      );
+      const allowed = config.enabledLlmServices.some((s) => s === service.name || s === service.title);
       if (!allowed) {
         ctx.status = 403;
         ctx.body = (0, import_openai_format.toOpenAIError)(

package/dist/server/routes/models.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;
@@ -34,10 +43,7 @@ async function handleListModels(ctx, plugin) {
     const config = await getPluginConfig(ctx);
     const filter = {};
     if ((_a = config == null ? void 0 : config.enabledLlmServices) == null ? void 0 : _a.length) {
-      filter.$or = [
-        { name: { $in: config.enabledLlmServices } },
-        { title: { $in: config.enabledLlmServices } }
-      ];
+      filter.$or = [{ name: { $in: config.enabledLlmServices } }, { title: { $in: config.enabledLlmServices } }];
     }
     const services = await ctx.db.getRepository("llmServices").find({
       filter,
@@ -77,10 +83,7 @@ async function handleGetModel(ctx, modelId, plugin) {
     const config = await getPluginConfig(ctx);
     const filter = {};
     if ((_a = config == null ? void 0 : config.enabledLlmServices) == null ? void 0 : _a.length) {
-      filter.$or = [
-        { name: { $in: config.enabledLlmServices } },
-        { title: { $in: config.enabledLlmServices } }
-      ];
+      filter.$or = [{ name: { $in: config.enabledLlmServices } }, { title: { $in: config.enabledLlmServices } }];
     }
     const services = await ctx.db.getRepository("llmServices").find({
       filter,

package/dist/server/routes/router.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;
@@ -39,6 +48,7 @@ var import_agent_completions = require("./agent-completions");
 var import_embeddings = require("./embeddings");
 var import_openai_format = require("../utils/openai-format");
 var import_rate_limit = require("../middleware/rate-limit");
+var import_role_permission = require("../middleware/role-permission");
 const API_PREFIX = "/api/ai-llm/v1";
 function createAiLlmRouter(plugin) {
   const checkRateLimit = (0, import_rate_limit.createRateLimitMiddleware)(plugin.rateLimiter);
@@ -78,6 +88,11 @@ function createAiLlmRouter(plugin) {
       logRequest(ctx, requestId, "-", "auth_failed", 0);
       return;
     }
+    const permitted = await (0, import_role_permission.checkRolePermission)(ctx);
+    if (!permitted) {
+      logRequest(ctx, requestId, "-", "forbidden", 0);
+      return;
+    }
     const allowed = await checkRateLimit(ctx);
     if (!allowed) {
       logRequest(ctx, requestId, "-", "rate_limited", 0);
@@ -98,7 +113,17 @@ function createAiLlmRouter(plugin) {
         return;
       }
       if (method === "POST" && subPath === "/completions") {
-        await (0, import_completions.handleCompletions)(ctx, plugin);
+        const completionsMode = await resolveMode(ctx);
+        if (completionsMode === "agent") {
+          const reqBody = ctx.request.body;
+          if ((reqBody == null ? void 0 : reqBody.prompt) !== void 0) {
+            const prompt = typeof reqBody.prompt === "string" ? reqBody.prompt : Array.isArray(reqBody.prompt) ? reqBody.prompt.join("\n") : String(reqBody.prompt);
+            ctx.request.body = { ...reqBody, messages: [{ role: "user", content: prompt }] };
+          }
+          await (0, import_agent_completions.handleAgentCompletions)(ctx, plugin);
+        } else {
+          await (0, import_completions.handleCompletions)(ctx, plugin);
+        }
         logRequest(ctx, requestId, model, "ok", Date.now() - t0);
         return;
       }
@@ -163,18 +188,25 @@ function getRawBody(ctx) {
   });
 }
 async function resolveMode(ctx) {
-  var _a;
+  var _a, _b, _c, _d, _e;
   const headerMode = (_a = ctx.get("X-AI-Mode")) == null ? void 0 : _a.toLowerCase();
   if (headerMode === "agent" || headerMode === "llm") {
+    (_b = ctx.app.logger) == null ? void 0 : _b.info(`[ai-api] Mode resolved from header: ${headerMode}`);
     return headerMode;
   }
   try {
     const config = await ctx.db.getRepository("aiApiConfig").findOne();
-    if ((config == null ? void 0 : config.mode) === "agent" || (config == null ? void 0 : config.mode) === "llm") {
-      return config.mode;
+    if (config) {
+      const dbMode = config.get("mode") || config.mode;
+      if (dbMode === "agent" || dbMode === "llm") {
+        (_c = ctx.app.logger) == null ? void 0 : _c.info(`[ai-api] Mode resolved from DB config: ${dbMode}`);
+        return dbMode;
+      }
     }
-  } catch {
+  } catch (err) {
+    (_d = ctx.app.logger) == null ? void 0 : _d.error("[ai-api] Failed to get mode from config:", err);
   }
+  (_e = ctx.app.logger) == null ? void 0 : _e.info(`[ai-api] Mode fallback to default: llm`);
   return "llm";
 }
 function logRequest(ctx, requestId, model, status, durationMs) {

package/dist/server/utils/openai-format.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/utils/rate-limiter.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/utils/resolve-service.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/swagger.js

@@ -0,0 +1,345 @@
+/**
+ * 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 swagger_exports = {};
+__export(swagger_exports, {
+  default: () => swagger_default
+});
+module.exports = __toCommonJS(swagger_exports);
+var swagger_default = {
+  info: {
+    title: "NocoBase API - AI API Plugin",
+    description: "OpenAI-compatible AI gateway and configuration API"
+  },
+  tags: [
+    { name: "aiApiConfig", description: "AI API configuration management" },
+    { name: "ai-llm", description: "OpenAI-compatible LLM gateway (prefix: /api/ai-llm/v1)" }
+  ],
+  paths: {
+    "/aiApiConfig:get": {
+      get: {
+        tags: ["aiApiConfig"],
+        summary: "Get AI API configuration",
+        security: [{ BearerAuth: [] }],
+        responses: {
+          200: {
+            description: "Current AI API configuration",
+            content: {
+              "application/json": {
+                schema: { $ref: "#/components/schemas/AiApiConfig" }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/aiApiConfig:save": {
+      post: {
+        tags: ["aiApiConfig"],
+        summary: "Save AI API configuration",
+        security: [{ BearerAuth: [] }],
+        requestBody: {
+          required: true,
+          content: {
+            "application/json": {
+              schema: { $ref: "#/components/schemas/AiApiConfig" }
+            }
+          }
+        },
+        responses: {
+          200: { description: "Configuration saved successfully" }
+        }
+      }
+    },
+    "/ai-llm/v1/models": {
+      get: {
+        tags: ["ai-llm"],
+        summary: "List available models",
+        description: "Returns all LLM models available across registered services. Model IDs are formatted as `serviceName/modelId`.",
+        security: [{ BearerAuth: [] }],
+        responses: {
+          200: {
+            description: "List of available models",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object",
+                  properties: {
+                    object: { type: "string", example: "list" },
+                    data: {
+                      type: "array",
+                      items: { $ref: "#/components/schemas/ModelObject" }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/ai-llm/v1/models/{id}": {
+      get: {
+        tags: ["ai-llm"],
+        summary: "Get model details",
+        security: [{ BearerAuth: [] }],
+        parameters: [
+          {
+            name: "id",
+            in: "path",
+            required: true,
+            description: "Model ID in format `serviceName/modelId`",
+            schema: { type: "string", example: "openai/gpt-4o" }
+          }
+        ],
+        responses: {
+          200: {
+            description: "Model details",
+            content: {
+              "application/json": {
+                schema: { $ref: "#/components/schemas/ModelObject" }
+              }
+            }
+          },
+          404: { description: "Model not found" }
+        }
+      }
+    },
+    "/ai-llm/v1/chat/completions": {
+      post: {
+        tags: ["ai-llm"],
+        summary: "Chat completions",
+        description: "OpenAI-compatible chat completions endpoint. Supports streaming (`stream: true`). Use header `X-AI-Mode: llm` (default) or `X-AI-Mode: agent` to switch between direct LLM and agent mode.",
+        security: [{ BearerAuth: [] }],
+        parameters: [
+          {
+            name: "X-AI-Mode",
+            in: "header",
+            required: false,
+            description: "AI mode: `llm` (default) or `agent`",
+            schema: { type: "string", enum: ["llm", "agent"], default: "llm" }
+          }
+        ],
+        requestBody: {
+          required: true,
+          content: {
+            "application/json": {
+              schema: { $ref: "#/components/schemas/ChatCompletionRequest" }
+            }
+          }
+        },
+        responses: {
+          200: {
+            description: "Chat completion response (or SSE stream when `stream: true`)",
+            content: {
+              "application/json": {
+                schema: { $ref: "#/components/schemas/ChatCompletionResponse" }
+              },
+              "text/event-stream": {
+                schema: { type: "string", description: "SSE stream of completion chunks" }
+              }
+            }
+          },
+          429: { description: "Rate limit exceeded" }
+        }
+      }
+    },
+    "/ai-llm/v1/completions": {
+      post: {
+        tags: ["ai-llm"],
+        summary: "Text completions (legacy)",
+        description: "Legacy text completions for LiteLLM compatibility.",
+        security: [{ BearerAuth: [] }],
+        requestBody: {
+          required: true,
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  model: { type: "string" },
+                  prompt: { type: "string" },
+                  max_tokens: { type: "integer" },
+                  stream: { type: "boolean", default: false }
+                },
+                required: ["model", "prompt"]
+              }
+            }
+          }
+        },
+        responses: {
+          200: { description: "Completion response" },
+          429: { description: "Rate limit exceeded" }
+        }
+      }
+    },
+    "/ai-llm/v1/embeddings": {
+      post: {
+        tags: ["ai-llm"],
+        summary: "Generate embeddings",
+        description: "OpenAI-compatible embeddings endpoint.",
+        security: [{ BearerAuth: [] }],
+        requestBody: {
+          required: true,
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  model: { type: "string", example: "openai/text-embedding-ada-002" },
+                  input: {
+                    oneOf: [{ type: "string" }, { type: "array", items: { type: "string" } }]
+                  }
+                },
+                required: ["model", "input"]
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            description: "Embedding vectors",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object",
+                  properties: {
+                    object: { type: "string", example: "list" },
+                    data: {
+                      type: "array",
+                      items: {
+                        type: "object",
+                        properties: {
+                          object: { type: "string", example: "embedding" },
+                          embedding: { type: "array", items: { type: "number" } },
+                          index: { type: "integer" }
+                        }
+                      }
+                    },
+                    model: { type: "string" },
+                    usage: {
+                      type: "object",
+                      properties: {
+                        prompt_tokens: { type: "integer" },
+                        total_tokens: { type: "integer" }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          429: { description: "Rate limit exceeded" }
+        }
+      }
+    }
+  },
+  components: {
+    schemas: {
+      AiApiConfig: {
+        type: "object",
+        properties: {
+          mode: {
+            type: "string",
+            enum: ["llm", "agent"],
+            description: "Default AI mode"
+          },
+          defaultAiEmployee: { type: "string", description: "Default AI employee name" },
+          defaultLlmService: { type: "string", description: "Default LLM service name" },
+          enabledLlmServices: {
+            type: "array",
+            items: { type: "string" },
+            description: "List of enabled LLM service names"
+          },
+          rateLimitPerMinute: {
+            type: "integer",
+            description: "Max requests per minute per user (0 = unlimited)"
+          }
+        }
+      },
+      ModelObject: {
+        type: "object",
+        properties: {
+          id: { type: "string", example: "openai/gpt-4o", description: "Model ID (serviceName/modelId)" },
+          object: { type: "string", example: "model" },
+          created: { type: "integer" },
+          owned_by: { type: "string" }
+        }
+      },
+      ChatMessage: {
+        type: "object",
+        properties: {
+          role: { type: "string", enum: ["system", "user", "assistant", "tool"] },
+          content: { type: "string" },
+          name: { type: "string" }
+        },
+        required: ["role", "content"]
+      },
+      ChatCompletionRequest: {
+        type: "object",
+        properties: {
+          model: { type: "string", example: "openai/gpt-4o" },
+          messages: { type: "array", items: { $ref: "#/components/schemas/ChatMessage" } },
+          stream: { type: "boolean", default: false },
+          temperature: { type: "number", minimum: 0, maximum: 2 },
+          max_tokens: { type: "integer" },
+          top_p: { type: "number" },
+          frequency_penalty: { type: "number" },
+          presence_penalty: { type: "number" }
+        },
+        required: ["model", "messages"]
+      },
+      ChatCompletionResponse: {
+        type: "object",
+        properties: {
+          id: { type: "string" },
+          object: { type: "string", example: "chat.completion" },
+          created: { type: "integer" },
+          model: { type: "string" },
+          choices: {
+            type: "array",
+            items: {
+              type: "object",
+              properties: {
+                index: { type: "integer" },
+                message: { $ref: "#/components/schemas/ChatMessage" },
+                finish_reason: { type: "string", enum: ["stop", "length", "tool_calls"] }
+              }
+            }
+          },
+          usage: {
+            type: "object",
+            properties: {
+              prompt_tokens: { type: "integer" },
+              completion_tokens: { type: "integer" },
+              total_tokens: { type: "integer" }
+            }
+          }
+        }
+      }
+    }
+  }
+};

package/package.json

@@ -1,13 +1,14 @@
-{
-  "name": "plugin-ai-api",
-  "version": "1.0.1",
-  "main": "dist/server/index.js",
-  "dependencies": {},
-  "peerDependencies": {
-    "@nocobase/client": "2.x",
-    "@nocobase/server": "2.x",
-    "@nocobase/database": "2.x",
-    "@nocobase/plugin-ai": "2.x",
-    "@nocobase/plugin-api-keys": "2.x"
-  }
-}
+{
+  "name": "plugin-ai-api",
+  "version": "1.0.3",
+  "main": "dist/server/index.js",
+  "dependencies": {},
+  "peerDependencies": {
+    "@nocobase/client": "2.x",
+    "@nocobase/server": "2.x",
+    "@nocobase/database": "2.x",
+    "@nocobase/plugin-acl": "2.x",
+    "@nocobase/plugin-ai": "2.x",
+    "@nocobase/plugin-api-keys": "2.x"
+  }
+}

package/dist/client/AiApiConfigPage.d.ts

@@ -1,3 +0,0 @@
-import React from 'react';
-export declare function AiApiConfigPage(): React.JSX.Element;
-export default AiApiConfigPage;

package/dist/client/index.d.ts

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

package/dist/client/locale.d.ts

@@ -1,10 +0,0 @@
-/**
- * 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.
- */
-export declare function useT(): (str: string) => any;
-export declare function tExpr(key: string): any;

package/dist/client/models/index.d.ts

@@ -1,10 +0,0 @@
-/**
- * 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.
- */
-declare const _default: Record<string, ModelConstructor>;
-export default _default;

package/dist/client/plugin.d.ts

@@ -1,6 +0,0 @@
-import { Plugin } from '@nocobase/client';
-export declare class PluginAiApiClient extends Plugin {
-    load(): Promise<void>;
-    t: (key: string) => string;
-}
-export default PluginAiApiClient;

package/dist/index.d.ts

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

package/dist/server/collections/ai-api-config.d.ts

@@ -1,2 +0,0 @@
-declare const _default: any;
-export default _default;

package/dist/server/index.d.ts

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

package/dist/server/middleware/rate-limit.d.ts

@@ -1,18 +0,0 @@
-import { RateLimiter } from '../utils/rate-limiter';
-/**
- * Creates a rate-limiting check function for use in the AI API router.
- *
- * Must be called AFTER authenticateBearer() so ctx.state.currentUser is set.
- * Reads rateLimitPerMinute from aiApiConfig on each request (cheap single-row read,
- * allows config changes to take effect immediately without restart).
- * Falls back to 60 req/min if the config record is missing or the field is 0/null.
- *
- * Returns false (and writes the 429 response) when the rate limit is exceeded.
- * Returns true when the request is allowed.
- *
- * Sets OpenAI-compatible rate limit response headers on every request:
- *   X-RateLimit-Limit: <limit>
- *   X-RateLimit-Remaining: <remaining> (on 429: 0)
- *   Retry-After: <seconds>  (on 429 only)
- */
-export declare function createRateLimitMiddleware(limiter: RateLimiter): (ctx: Context) => Promise<boolean>;