@nocobase/plugin-ai 2.2.0-beta.1 → 2.2.0-beta.10

package/dist/server/llm-providers/orcarouter.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 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.
+ */
+import { LLMProvider } from './provider';
+import { LLMProviderMeta } from '../manager/ai-manager';
+import { AIMessageChunk, BaseMessageChunk } from '@langchain/core/messages';
+import { ReasoningChatOpenAI } from './common/reasoning';
+import { AttachmentModel } from '@nocobase/plugin-file-manager';
+import { Model } from '@nocobase/database';
+export declare class OrcaRouterProvider extends LLMProvider {
+    chatModel: ReasoningChatOpenAI;
+    get baseURL(): string;
+    createModel(): ChatOrcaRouterCompletions;
+    protected isApiSupportedAttachment(attachment: AttachmentModel): boolean;
+    parseResponseMessage(message: Model): {
+        key: any;
+        createdAt: any;
+        content: any;
+        role: any;
+    };
+    parseReasoningContent(chunk: AIMessageChunk): {
+        status: string;
+        content: string;
+    };
+}
+declare class ChatOrcaRouterCompletions extends ReasoningChatOpenAI {
+    _convertCompletionsDeltaToBaseMessageChunk(delta: any, rawResponse: any, defaultRole: any): BaseMessageChunk;
+}
+export declare const orcarouterProviderOptions: LLMProviderMeta;
+export {};

package/dist/server/llm-providers/orcarouter.js

@@ -0,0 +1,155 @@
+/**
+ * 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 orcarouter_exports = {};
+__export(orcarouter_exports, {
+  OrcaRouterProvider: () => OrcaRouterProvider,
+  orcarouterProviderOptions: () => orcarouterProviderOptions
+});
+module.exports = __toCommonJS(orcarouter_exports);
+var import_provider = require("./provider");
+var import_ai_manager = require("../manager/ai-manager");
+var import_lodash = __toESM(require("lodash"));
+var import_openai = require("@langchain/openai");
+var import_messages = require("@langchain/core/messages");
+var import_reasoning = require("./common/reasoning");
+class OrcaRouterProvider extends import_provider.LLMProvider {
+  get baseURL() {
+    return "https://api.orcarouter.ai/v1";
+  }
+  createModel() {
+    const { apiKey, httpReferer, xTitle } = this.serviceOptions || {};
+    const { responseFormat, structuredOutput } = this.modelOptions || {};
+    const { name, schema } = structuredOutput || {};
+    const responseFormatOptions = {
+      type: responseFormat ?? "text"
+    };
+    if (responseFormat === "json_schema" && schema) {
+      responseFormatOptions["json_schema"] = { schema, name: name ?? "schema" };
+    }
+    const defaultHeaders = {};
+    if (httpReferer) {
+      defaultHeaders["HTTP-Referer"] = httpReferer;
+    }
+    if (xTitle) {
+      defaultHeaders["X-Title"] = xTitle;
+    }
+    return new ChatOrcaRouterCompletions({
+      apiKey,
+      ...this.modelOptions,
+      modelKwargs: {
+        response_format: responseFormatOptions
+      },
+      configuration: {
+        baseURL: this.getResolvedBaseURL(),
+        ...Object.keys(defaultHeaders).length ? { defaultHeaders } : {}
+      }
+    });
+  }
+  isApiSupportedAttachment(attachment) {
+    const media = ["image/"];
+    return media.some((it) => {
+      var _a;
+      return (_a = attachment == null ? void 0 : attachment.mimetype) == null ? void 0 : _a.startsWith(it);
+    });
+  }
+  parseResponseMessage(message) {
+    var _a;
+    const result = super.parseResponseMessage(message);
+    if (["user", "tool"].includes(result == null ? void 0 : result.role)) {
+      return result;
+    }
+    const { metadata } = (message == null ? void 0 : message.toJSON()) ?? {};
+    if (!import_lodash.default.isEmpty((_a = metadata == null ? void 0 : metadata.additional_kwargs) == null ? void 0 : _a.reasoning_content)) {
+      result.content = {
+        ...result.content ?? {},
+        reasoning: {
+          status: "stop",
+          content: metadata == null ? void 0 : metadata.additional_kwargs.reasoning_content
+        }
+      };
+    }
+    return result;
+  }
+  parseReasoningContent(chunk) {
+    var _a;
+    if (!import_lodash.default.isEmpty((_a = chunk == null ? void 0 : chunk.additional_kwargs) == null ? void 0 : _a.reasoning_content)) {
+      return {
+        status: "streaming",
+        content: chunk.additional_kwargs.reasoning_content
+      };
+    }
+    return null;
+  }
+}
+class ChatOrcaRouterCompletions extends import_reasoning.ReasoningChatOpenAI {
+  _convertCompletionsDeltaToBaseMessageChunk(delta, rawResponse, defaultRole) {
+    const chunk = (0, import_openai.convertCompletionsDeltaToBaseMessageChunk)({
+      delta,
+      rawResponse,
+      includeRawResponse: this.__includeRawResponse,
+      defaultRole
+    });
+    if (chunk instanceof import_messages.AIMessageChunk) {
+      if (delta.reasoning_content) {
+        chunk.additional_kwargs.reasoning_content = delta.reasoning_content;
+      }
+    }
+    return chunk;
+  }
+}
+const orcarouterProviderOptions = {
+  title: "OrcaRouter",
+  supportedModel: [import_ai_manager.SupportedModel.LLM],
+  models: {
+    [import_ai_manager.SupportedModel.LLM]: [
+      "orcarouter/auto",
+      "openai/gpt-5.5",
+      "google/gemini-3.5-flash",
+      "anthropic/claude-opus-4.8",
+      "grok/grok-4.3",
+      "deepseek/deepseek-v4-pro",
+      "minimax/minimax-m2.7",
+      "qwen/qwen3.7-max"
+    ]
+  },
+  provider: OrcaRouterProvider
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  OrcaRouterProvider,
+  orcarouterProviderOptions
+});

package/dist/server/llm-providers/provider.d.ts

@@ -10,9 +10,9 @@ import { BaseChatModel } from '@langchain/core/language_models/chat_models';
 import { Model } from '@nocobase/database';
 import { AttachmentModel } from '@nocobase/plugin-file-manager';
 import { Application } from '@nocobase/server';
-import { AIChatContext } from '../types/ai-chat-conversation.type';
+import { AIChatContext, AIMessageInput } from '../types/ai-chat-conversation.type';
 import { EmbeddingsInterface } from '@langchain/core/embeddings';
-import { AIMessageChunk } from '@langchain/core/messages';
+import { AIMessage, AIMessageChunk } from '@langchain/core/messages';
 import { Context } from '@nocobase/actions';
 import '@langchain/core/utils/stream';
 import { LLMResult } from '@langchain/core/outputs';
@@ -43,7 +43,7 @@ export interface LLMProviderOptions {
 export declare abstract class LLMProvider {
     app: Application;
     serviceOptions: Record<string, any>;
-    modelOptions: Record<string, any>;
+    modelOptions: Record<string, any> | undefined;
     chatModel: any;
     abstract createModel(): BaseChatModel | any;
     get baseURL(): string | null;
@@ -87,9 +87,13 @@ export declare abstract class LLMProvider {
     parseReasoningContent(chunk: AIMessageChunk): {
         status: string;
         content: string;
-    };
+    } | null;
     parseResponseMetadata(output: LLMResult): any;
     parseResponseError(err: any): any;
+    reshapeAIMessage(_options: {
+        aiMessage: AIMessage;
+        values: AIMessageInput;
+    }): void;
     protected get documentLoader(): CachedDocumentLoader;
     protected getResolvedBaseURL(): string;
     protected buildRequestURL(pathname: string): string;

package/dist/server/llm-providers/provider.js

@@ -46,15 +46,34 @@ var import_stream = require("@langchain/core/utils/stream");
 var import_document_loader = require("../document-loader");
 var import_node_path = __toESM(require("node:path"));
 var import_reasoning = require("./common/reasoning");
+function assertBaseURLString(baseURL) {
+  if (typeof baseURL !== "string") {
+    throw new Error("baseURL must be a string");
+  }
+}
 function normalizeBaseURL(baseURL) {
-  (0, import_utils.checkUrlAgainstWhitelist)(baseURL);
-  return new URL(baseURL).toString().replace(/\/$/, "");
+  assertBaseURLString(baseURL);
+  const trimmedBaseURL = baseURL.trim();
+  (0, import_utils.checkUrlAgainstWhitelist)(trimmedBaseURL);
+  return new URL(trimmedBaseURL).toString().replace(/\/$/, "");
+}
+function isBlankBaseURL(baseURL) {
+  return baseURL.trim() === "";
+}
+function getServiceBaseURL(serviceOptions) {
+  const baseURL = serviceOptions == null ? void 0 : serviceOptions.baseURL;
+  if (typeof baseURL === "string" && isBlankBaseURL(baseURL)) {
+    return null;
+  }
+  return baseURL;
 }
 function resolveServiceOptions(serviceOptions, app) {
   const rendered = app.environment.renderJsonTemplate(serviceOptions ?? {});
   if ((rendered == null ? void 0 : rendered.baseURL) != null) {
-    if (typeof rendered.baseURL !== "string") {
-      throw new Error("baseURL must be a string");
+    assertBaseURLString(rendered.baseURL);
+    if (isBlankBaseURL(rendered.baseURL)) {
+      delete rendered.baseURL;
+      return rendered;
     }
     rendered.baseURL = normalizeBaseURL(rendered.baseURL);
   }
@@ -268,6 +287,7 @@ ${parsed.text}
     };
     if (strict) {
       options["strict"] = strict;
+      options["method"] = "jsonSchema";
     }
     return {
       schema: {
@@ -318,18 +338,16 @@ ${parsed.text}
   parseResponseError(err) {
     return (err == null ? void 0 : err.message) ?? "Unexpected LLM service error";
   }
+  reshapeAIMessage(_options) {
+  }
   get documentLoader() {
     return this.aiPlugin.documentLoaders.cached;
   }
   getResolvedBaseURL() {
-    var _a;
-    const baseURL = ((_a = this.serviceOptions) == null ? void 0 : _a.baseURL) ?? this.baseURL;
+    const baseURL = getServiceBaseURL(this.serviceOptions) ?? this.baseURL;
     if (!baseURL) {
       throw new Error("baseURL is required");
     }
-    if (typeof baseURL !== "string") {
-      throw new Error("baseURL must be a string");
-    }
     return normalizeBaseURL(baseURL);
   }
   buildRequestURL(pathname) {
@@ -360,14 +378,10 @@ class EmbeddingProvider {
     return apiKey;
   }
   get baseURL() {
-    var _a;
-    const baseURL = ((_a = this.serviceOptions) == null ? void 0 : _a.baseURL) ?? this.getDefaultUrl();
+    const baseURL = getServiceBaseURL(this.serviceOptions) ?? this.getDefaultUrl();
     if (!baseURL) {
       throw new Error("baseURL is required");
     }
-    if (typeof baseURL !== "string") {
-      throw new Error("baseURL must be a string");
-    }
     return normalizeBaseURL(baseURL);
   }
   get model() {

package/dist/server/manager/ai-chat-conversation.js

@@ -40,6 +40,7 @@ __export(ai_chat_conversation_exports, {
 });
 module.exports = __toCommonJS(ai_chat_conversation_exports);
 var import_lodash = __toESM(require("lodash"));
+var import_ai_usage_events = require("./ai-usage-events");
 const createAIChatConversation = (ctx, sessionId) => {
   return new AIChatConversationImpl(ctx, sessionId);
 };
@@ -81,6 +82,7 @@ class AIChatConversationImpl {
       ),
       transaction: this.transaction
     });
+    await (0, import_ai_usage_events.recordAIUsageEventsForMessages)(this.ctx, this.sessionId, instances, this.transaction);
     return isArray ? instances : instances[0];
   }
   async removeMessages({ messageId }) {

package/dist/server/manager/ai-usage-events.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 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.
+ */
+import { Context } from '@nocobase/actions';
+import { Transaction } from '@nocobase/database';
+import { AIMessage } from '../types';
+type RecordLike = Record<string, unknown> & {
+    get?: (key: string) => unknown;
+};
+export type NormalizedUsageMetadata = {
+    inputTokens: number;
+    outputTokens: number;
+    totalTokens: number;
+    cachedTokens: number;
+    reasoningTokens: number;
+};
+export type AIUsageEventValues = {
+    occurredAt: Date;
+    sessionId: string;
+    messageId: string;
+    userId?: unknown;
+    aiEmployeeUsername?: unknown;
+    from: string;
+    category: string;
+    eventType: 'llm_message';
+    role: string;
+    provider: string;
+    llmService?: string;
+    model: string;
+    inputTokens: number;
+    outputTokens: number;
+    totalTokens: number;
+    cachedTokens: number;
+    reasoningTokens: number;
+    toolCallCount: number;
+    autoToolCallCount: number;
+    status: 'success';
+    rawUsageMetadata: Record<string, unknown>;
+    rawResponseMetadata?: Record<string, unknown>;
+};
+export declare function normalizeUsageMetadata(usageMetadata: Record<string, unknown>): NormalizedUsageMetadata;
+export declare function buildAIUsageEventValues(sessionId: string, message: AIMessage, conversation: RecordLike): AIUsageEventValues | null;
+export declare function recordAIUsageEventsForMessages(ctx: Context, sessionId: string, messages: AIMessage[], transaction?: Transaction): Promise<void>;
+export {};

package/dist/server/manager/ai-usage-events.js

@@ -0,0 +1,195 @@
+/**
+ * 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_usage_events_exports = {};
+__export(ai_usage_events_exports, {
+  buildAIUsageEventValues: () => buildAIUsageEventValues,
+  normalizeUsageMetadata: () => normalizeUsageMetadata,
+  recordAIUsageEventsForMessages: () => recordAIUsageEventsForMessages
+});
+module.exports = __toCommonJS(ai_usage_events_exports);
+const SKIPPED_MESSAGE_ROLES = /* @__PURE__ */ new Set(["user", "tool", "system"]);
+function normalizeUsageMetadata(usageMetadata) {
+  const inputTokens = getNumericValue(usageMetadata, ["input_tokens", "prompt_tokens", "inputTokens", "promptTokens"]) ?? 0;
+  const outputTokens = getNumericValue(usageMetadata, ["output_tokens", "completion_tokens", "outputTokens", "completionTokens"]) ?? 0;
+  const totalTokens = getNumericValue(usageMetadata, ["total_tokens", "totalTokens"]) ?? inputTokens + outputTokens;
+  const cachedTokens = getNumericValue(usageMetadata, ["cached_tokens", "cachedTokens"]) ?? getNestedNumericValue(usageMetadata, ["input_token_details", "cache_read"]) ?? getNestedNumericValue(usageMetadata, ["input_token_details", "cached_tokens"]) ?? getNestedNumericValue(usageMetadata, ["prompt_tokens_details", "cached_tokens"]) ?? 0;
+  const reasoningTokens = getNumericValue(usageMetadata, ["reasoning_tokens", "reasoningTokens"]) ?? getNestedNumericValue(usageMetadata, ["output_token_details", "reasoning"]) ?? getNestedNumericValue(usageMetadata, ["completion_tokens_details", "reasoning_tokens"]) ?? 0;
+  return {
+    inputTokens,
+    outputTokens,
+    totalTokens,
+    cachedTokens,
+    reasoningTokens
+  };
+}
+function buildAIUsageEventValues(sessionId, message, conversation) {
+  const role = readString(message, "role");
+  if (!role || SKIPPED_MESSAGE_ROLES.has(role)) {
+    return null;
+  }
+  const metadata = readRecord(message, "metadata");
+  const provider = readString(metadata, "provider");
+  const model = readString(metadata, "model");
+  if (!provider || !model) {
+    return null;
+  }
+  const usageMetadata = readRecord(metadata, "usage_metadata") ?? {};
+  const responseMetadata = readRecord(metadata, "response_metadata");
+  const normalizedUsage = normalizeUsageMetadata(usageMetadata);
+  const toolCalls = readArray(message, "toolCalls");
+  const autoCallTools = readArray(metadata, "autoCallTools");
+  const llmService = readString(metadata, "llmService");
+  return {
+    occurredAt: normalizeDate(readValue(message, "createdAt")),
+    sessionId,
+    messageId: String(readValue(message, "messageId") ?? ""),
+    userId: readValue(conversation, "userId"),
+    aiEmployeeUsername: readValue(conversation, "aiEmployeeUsername"),
+    from: readString(conversation, "from") ?? "main-agent",
+    category: readString(conversation, "category") ?? "chat",
+    eventType: "llm_message",
+    role,
+    provider,
+    ...llmService ? { llmService } : {},
+    model,
+    ...normalizedUsage,
+    toolCallCount: (toolCalls == null ? void 0 : toolCalls.length) ?? 0,
+    autoToolCallCount: (autoCallTools == null ? void 0 : autoCallTools.length) ?? 0,
+    status: "success",
+    rawUsageMetadata: usageMetadata,
+    ...responseMetadata ? { rawResponseMetadata: responseMetadata } : {}
+  };
+}
+async function recordAIUsageEventsForMessages(ctx, sessionId, messages, transaction) {
+  const recordableMessages = messages.filter(isRecordableLLMMessage);
+  if (recordableMessages.length === 0) {
+    return;
+  }
+  const conversation = await ctx.db.getRepository("aiConversations").findOne({
+    filter: {
+      sessionId
+    },
+    transaction
+  });
+  if (!conversation) {
+    return;
+  }
+  const usageEvents = recordableMessages.map((message) => buildAIUsageEventValues(sessionId, message, conversation)).filter(isUsageEventValues);
+  if (usageEvents.length === 0) {
+    return;
+  }
+  const usageEventsRepo = ctx.db.getRepository("aiUsageEvents");
+  for (const values of usageEvents) {
+    await usageEventsRepo.updateOrCreate({
+      filterKeys: ["messageId", "eventType"],
+      values,
+      transaction
+    });
+  }
+}
+function isUsageEventValues(value) {
+  return value !== null && value.messageId !== "";
+}
+function isRecordableLLMMessage(message) {
+  const role = readString(message, "role");
+  if (!role || SKIPPED_MESSAGE_ROLES.has(role)) {
+    return false;
+  }
+  const metadata = readRecord(message, "metadata");
+  return Boolean(readString(metadata, "provider") && readString(metadata, "model"));
+}
+function isRecord(value) {
+  return Boolean(value) && typeof value === "object" && !Array.isArray(value);
+}
+function readValue(source, key) {
+  if (!isRecord(source)) {
+    return void 0;
+  }
+  const value = source[key];
+  if (value !== void 0) {
+    return value;
+  }
+  if (typeof source.get === "function") {
+    return source.get(key);
+  }
+  return void 0;
+}
+function readString(source, key) {
+  const value = readValue(source, key);
+  return typeof value === "string" && value !== "" ? value : void 0;
+}
+function readRecord(source, key) {
+  const value = readValue(source, key);
+  return isRecord(value) ? value : void 0;
+}
+function readArray(source, key) {
+  const value = readValue(source, key);
+  return Array.isArray(value) ? value : void 0;
+}
+function getNumericValue(source, keys) {
+  for (const key of keys) {
+    const normalized = normalizeNumber(source[key]);
+    if (normalized !== void 0) {
+      return normalized;
+    }
+  }
+}
+function getNestedNumericValue(source, path) {
+  let current = source;
+  for (const key of path) {
+    if (!isRecord(current)) {
+      return void 0;
+    }
+    current = current[key];
+  }
+  return normalizeNumber(current);
+}
+function normalizeNumber(value) {
+  const numeric = typeof value === "number" ? value : typeof value === "string" ? Number(value) : NaN;
+  if (!Number.isFinite(numeric)) {
+    return void 0;
+  }
+  return Math.max(0, Math.trunc(numeric));
+}
+function normalizeDate(value) {
+  if (value instanceof Date && Number.isFinite(value.getTime())) {
+    return value;
+  }
+  if (typeof value === "string" || typeof value === "number") {
+    const date = new Date(value);
+    if (Number.isFinite(date.getTime())) {
+      return date;
+    }
+  }
+  return /* @__PURE__ */ new Date();
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  buildAIUsageEventValues,
+  normalizeUsageMetadata,
+  recordAIUsageEventsForMessages
+});

package/dist/server/plugin.d.ts

@@ -43,10 +43,13 @@ export declare class PluginAIServer extends Plugin {
     isBuilderAI(username: string): boolean;
     afterAdd(): Promise<void>;
     beforeLoad(): Promise<void>;
+    private resetConversationThreadsWhenCheckpointsEmpty;
     load(): Promise<void>;
     registerLLMProviders(): void;
     registerTools(): void;
     defineResources(): void;
+    registerMcpClientEvents(): void;
+    private clearMcpUserContextCacheAfterCommit;
     setPermissions(): void;
     registerWorkflow(): void;
     registerWorkContextResolveStrategy(): void;