plugin-ai-api 1.0.15 → 1.0.21

package/src/client-v2/pages/UserQuotasPage.tsx

@@ -0,0 +1,258 @@
+import React, { useCallback, useEffect, useState } from 'react';
+import {
+  Button,
+  Card,
+  Form,
+  Input,
+  InputNumber,
+  Modal,
+  Popconfirm,
+  Select,
+  Space,
+  Switch,
+  Table,
+  Tag,
+  message,
+} from 'antd';
+import type { ColumnsType } from 'antd/es/table';
+import { useFlowContext } from '@nocobase/flow-engine';
+import { useT } from '../locale';
+import { errorMessage, unwrapData } from './api';
+
+interface UserSummary {
+  id: string | number;
+  nickname?: string;
+  username?: string;
+  email?: string;
+}
+
+interface QuotaPolicy {
+  id: string | number;
+  userId: string | number;
+  user?: UserSummary;
+  enabled: boolean;
+  periodType: 'daily' | 'monthly';
+  timezone: string;
+  requestLimit?: string;
+  totalTokenLimit?: string;
+  costLimit?: string;
+  currency: string;
+  rejectUnpricedModel: boolean;
+  missingUsageBehavior: 'allow' | 'use_reserved';
+}
+
+export default function UserQuotasPage() {
+  const ctx = useFlowContext();
+  const t = useT();
+  const [form] = Form.useForm<QuotaPolicy>();
+  const [rows, setRows] = useState<QuotaPolicy[]>([]);
+  const [users, setUsers] = useState<UserSummary[]>([]);
+  const [loading, setLoading] = useState(false);
+  const [saving, setSaving] = useState(false);
+  const [editing, setEditing] = useState<QuotaPolicy>();
+  const [open, setOpen] = useState(false);
+
+  const load = useCallback(async () => {
+    setLoading(true);
+    try {
+      const [policiesResponse, usersResponse] = await Promise.all([
+        ctx.api.request({
+          url: 'aiApiUserQuotaPolicies:list',
+          method: 'get',
+          params: { pageSize: 200, appends: ['user'], sort: '-updatedAt' },
+        }),
+        ctx.api.request({ url: 'users:list', method: 'get', params: { pageSize: 200 } }),
+      ]);
+      setRows(unwrapData<QuotaPolicy[]>(policiesResponse, []));
+      setUsers(unwrapData<UserSummary[]>(usersResponse, []));
+    } catch (error) {
+      message.error(errorMessage(error));
+    } finally {
+      setLoading(false);
+    }
+  }, [ctx.api]);
+
+  useEffect(() => {
+    load();
+  }, [load]);
+
+  const showCreate = () => {
+    setEditing(undefined);
+    form.setFieldsValue({
+      enabled: true,
+      periodType: 'monthly',
+      timezone: 'UTC',
+      currency: 'USD',
+      rejectUnpricedModel: true,
+      missingUsageBehavior: 'use_reserved',
+    } as QuotaPolicy);
+    setOpen(true);
+  };
+
+  const showEdit = (record: QuotaPolicy) => {
+    setEditing(record);
+    form.setFieldsValue(record);
+    setOpen(true);
+  };
+
+  const save = async () => {
+    const values = await form.validateFields();
+    setSaving(true);
+    try {
+      await ctx.api.request({
+        url: editing ? `aiApiUserQuotaPolicies:update/${editing.id}` : 'aiApiUserQuotaPolicies:create',
+        method: 'post',
+        data: values,
+      });
+      message.success(t('Saved successfully'));
+      setOpen(false);
+      await load();
+    } catch (error) {
+      message.error(errorMessage(error));
+    } finally {
+      setSaving(false);
+    }
+  };
+
+  const remove = async (record: QuotaPolicy) => {
+    try {
+      await ctx.api.request({
+        url: `aiApiUserQuotaPolicies:destroy/${record.id}`,
+        method: 'post',
+      });
+      message.success(t('Deleted successfully'));
+      await load();
+    } catch (error) {
+      message.error(errorMessage(error));
+    }
+  };
+
+  const userLabel = (user?: UserSummary) => user?.nickname || user?.username || user?.email || String(user?.id ?? '');
+  const columns: ColumnsType<QuotaPolicy> = [
+    {
+      title: t('User'),
+      key: 'user',
+      width: 180,
+      render: (_, record) => userLabel(record.user) || String(record.userId),
+    },
+    { title: t('Period'), dataIndex: 'periodType', key: 'periodType', width: 100 },
+    {
+      title: t('Request limit'),
+      dataIndex: 'requestLimit',
+      key: 'requestLimit',
+      width: 130,
+      render: (value) => value ?? t('Unlimited'),
+    },
+    {
+      title: t('Token limit'),
+      dataIndex: 'totalTokenLimit',
+      key: 'totalTokenLimit',
+      width: 130,
+      render: (value) => value ?? t('Unlimited'),
+    },
+    {
+      title: t('Cost limit'),
+      dataIndex: 'costLimit',
+      key: 'costLimit',
+      width: 120,
+      render: (value, record) => (value == null ? t('Unlimited') : `${value} ${record.currency}`),
+    },
+    { title: t('Timezone'), dataIndex: 'timezone', key: 'timezone', width: 140 },
+    {
+      title: t('Status'),
+      dataIndex: 'enabled',
+      key: 'enabled',
+      width: 100,
+      render: (enabled: boolean) => (
+        <Tag color={enabled ? 'green' : 'default'}>{enabled ? t('Enabled') : t('Disabled')}</Tag>
+      ),
+    },
+    {
+      title: t('Actions'),
+      key: 'actions',
+      width: 150,
+      fixed: 'right',
+      render: (_, record) => (
+        <Space size={0}>
+          <Button type="link" onClick={() => showEdit(record)}>
+            {t('Edit')}
+          </Button>
+          <Popconfirm title={t('Delete this quota?')} onConfirm={() => remove(record)}>
+            <Button type="link" danger>
+              {t('Delete')}
+            </Button>
+          </Popconfirm>
+        </Space>
+      ),
+    },
+  ];
+
+  return (
+    <Card
+      title={t('User quotas')}
+      extra={
+        <Button type="primary" onClick={showCreate}>
+          {t('Add quota')}
+        </Button>
+      }
+    >
+      <Table rowKey="id" columns={columns} dataSource={rows} loading={loading} scroll={{ x: 1100 }} />
+      <Modal
+        title={editing ? t('Edit quota') : t('Add quota')}
+        open={open}
+        onCancel={() => setOpen(false)}
+        onOk={save}
+        confirmLoading={saving}
+        destroyOnClose
+      >
+        <Form form={form} layout="vertical" preserve={false}>
+          <Form.Item name="userId" label={t('User')} rules={[{ required: true }]}>
+            <Select
+              disabled={Boolean(editing)}
+              showSearch
+              optionFilterProp="label"
+              options={users.map((user) => ({ label: userLabel(user), value: user.id }))}
+            />
+          </Form.Item>
+          <Form.Item name="periodType" label={t('Period')} rules={[{ required: true }]}>
+            <Select
+              options={[
+                { label: t('Daily'), value: 'daily' },
+                { label: t('Monthly'), value: 'monthly' },
+              ]}
+            />
+          </Form.Item>
+          <Form.Item name="timezone" label={t('Timezone')} rules={[{ required: true }]}>
+            <Input placeholder="UTC" />
+          </Form.Item>
+          <Form.Item name="requestLimit" label={t('Request limit')}>
+            <InputNumber min={0} stringMode style={{ width: '100%' }} />
+          </Form.Item>
+          <Form.Item name="totalTokenLimit" label={t('Token limit')}>
+            <InputNumber min={0} stringMode style={{ width: '100%' }} />
+          </Form.Item>
+          <Form.Item name="costLimit" label={t('Cost limit')}>
+            <InputNumber min={0} stringMode style={{ width: '100%' }} />
+          </Form.Item>
+          <Form.Item name="currency" label={t('Currency')} rules={[{ required: true }]}>
+            <Input />
+          </Form.Item>
+          <Form.Item name="rejectUnpricedModel" label={t('Reject unpriced models')} valuePropName="checked">
+            <Switch />
+          </Form.Item>
+          <Form.Item name="missingUsageBehavior" label={t('Missing usage behavior')} rules={[{ required: true }]}>
+            <Select
+              options={[
+                { label: t('Use reserved estimate'), value: 'use_reserved' },
+                { label: t('Allow without token charge'), value: 'allow' },
+              ]}
+            />
+          </Form.Item>
+          <Form.Item name="enabled" label={t('Enabled')} valuePropName="checked">
+            <Switch />
+          </Form.Item>
+        </Form>
+      </Modal>
+    </Card>
+  );
+}

package/src/client-v2/pages/api.ts

@@ -0,0 +1,16 @@
+export interface ApiEnvelope<T> {
+  data?: {
+    data?: T;
+    meta?: { count?: number };
+  };
+}
+
+export function unwrapData<T>(response: unknown, fallback: T): T {
+  if (!response || typeof response !== 'object') return fallback;
+  const outer = response as ApiEnvelope<T>;
+  return outer.data?.data ?? fallback;
+}
+
+export function errorMessage(error: unknown): string {
+  return error instanceof Error ? error.message : String(error);
+}

package/src/client-v2/plugin.tsx

@@ -1,5 +1,19 @@
-import { Plugin, Application } from '@nocobase/client-v2';
 import React from 'react';
+import { Plugin, Application } from '@nocobase/client-v2';
+import { AI_API_ACL_SNIPPET } from '../constants';
+
+interface PermissionTabOptions {
+  key: string;
+  label: string;
+  sort?: number;
+  componentLoader: () => Promise<{ default: React.ComponentType<{ activeRole?: { name?: string } | null }> }>;
+}
+
+interface AclPluginV2Compat {
+  settingsUI?: {
+    addPermissionsTab?: (options: PermissionTabOptions) => void;
+  };
+}
 
 export class PluginAiApiClient extends Plugin<Record<string, never>, Application> {
   async load() {
@@ -7,17 +21,61 @@ export class PluginAiApiClient extends Plugin<Record<string, never>, Application
       key: 'ai-api',
       title: this.t('AI API Gateway'),
       icon: 'ApiOutlined',
-      aclSnippet: 'pm.ai-api.configuration',
+      aclSnippet: AI_API_ACL_SNIPPET,
     });
 
     this.pluginSettingsManager.addPageTabItem({
       menuKey: 'ai-api',
       key: 'index',
       title: this.t('Configuration'),
-      
-      componentLoader: () => import('../client/AiApiConfigPage'),
+      aclSnippet: AI_API_ACL_SNIPPET,
+      sort: 1,
+      componentLoader: () => import('./pages/GeneralPage'),
     });
 
+    this.pluginSettingsManager.addPageTabItem({
+      menuKey: 'ai-api',
+      key: 'model-pricing',
+      title: this.t('Model pricing'),
+      aclSnippet: AI_API_ACL_SNIPPET,
+      sort: 2,
+      componentLoader: () => import('./pages/ModelPricingPage'),
+    });
+
+    this.pluginSettingsManager.addPageTabItem({
+      menuKey: 'ai-api',
+      key: 'model-metadata',
+      title: this.t('Model metadata'),
+      aclSnippet: AI_API_ACL_SNIPPET,
+      sort: 3,
+      componentLoader: () => import('./pages/ModelMetadataPage'),
+    });
+
+    this.pluginSettingsManager.addPageTabItem({
+      menuKey: 'ai-api',
+      key: 'user-quotas',
+      title: this.t('User quotas'),
+      aclSnippet: AI_API_ACL_SNIPPET,
+      sort: 4,
+      componentLoader: () => import('./pages/UserQuotasPage'),
+    });
+
+    this.pluginSettingsManager.addPageTabItem({
+      menuKey: 'ai-api',
+      key: 'usage',
+      title: this.t('Usage'),
+      aclSnippet: AI_API_ACL_SNIPPET,
+      sort: 5,
+      componentLoader: () => import('./pages/UsagePage'),
+    });
+
+    const aclPlugin = this.app.pm.get('@nocobase/plugin-acl') as AclPluginV2Compat | undefined;
+    aclPlugin?.settingsUI?.addPermissionsTab?.({
+      key: 'aiApi',
+      label: this.t('AI API'),
+      sort: 25,
+      componentLoader: () => import('./pages/RolePermissionsTab'),
+    });
   }
 }
 

package/src/constants.ts

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ */
+
+/**
+ * The single admin snippet the server registers as `pm.${this.name}.configuration`.
+ *
+ * `this.name` is the plugin's package name with only `@nocobase/plugin-` or
+ * `@nocobase/preset-` stripped (see utils/plugin-package `getPluginNameFromPackageName`),
+ * so for this unscoped package it stays `plugin-ai-api` — verified against the running
+ * app, which reports `name: "plugin-ai-api"`. Spelling it `pm.ai-api.configuration` on the
+ * client names a snippet no role can ever hold.
+ *
+ * Shared by both client runtimes so a rename cannot silently desynchronise them.
+ */
+export const AI_API_ACL_SNIPPET = 'pm.plugin-ai-api.configuration';

package/src/locale/en-US.json

@@ -1,10 +1,105 @@
-{
-  "AI API Gateway": "AI API Gateway",
-  "Configuration": "Configuration",
-  "Default AI Employee": "Default AI Employee",
-  "Enabled LLM Services": "Enabled LLM Services",
-  "Rate Limit": "Rate Limit",
-  "Save Configuration": "Save Configuration",
-  "Configuration saved": "Configuration saved",
-  "Failed to save configuration": "Failed to save configuration"
-}
+{
+  "AI API Gateway": "AI API Gateway",
+  "Configuration": "Configuration",
+  "Default AI Employee": "Default AI Employee",
+  "Enabled LLM Services": "Enabled LLM Services",
+  "Rate Limit": "Rate Limit",
+  "Save Configuration": "Save Configuration",
+  "Configuration saved": "Configuration saved",
+  "Failed to save configuration": "Failed to save configuration",
+  "API mode": "API mode",
+  "Direct LLM": "Direct LLM",
+  "AI Employee agent": "AI Employee agent",
+  "Default LLM service": "Default LLM service",
+  "Enable user quotas": "Enable user quotas",
+  "Default reserved output tokens": "Default reserved output tokens",
+  "Refresh": "Refresh",
+  "Model pricing": "Model pricing",
+  "User quotas": "User quotas",
+  "Usage": "Usage",
+  "LLM service": "LLM service",
+  "Model": "Model",
+  "Input price / 1M": "Input price / 1M",
+  "Output price / 1M": "Output price / 1M",
+  "Fixed request cost": "Fixed request cost",
+  "Currency": "Currency",
+  "Status": "Status",
+  "Enabled": "Enabled",
+  "Disabled": "Disabled",
+  "Actions": "Actions",
+  "Edit": "Edit",
+  "Delete": "Delete",
+  "Delete this price?": "Delete this price?",
+  "Add price": "Add price",
+  "Edit price": "Edit price",
+  "Effective from": "Effective from",
+  "Effective to": "Effective to",
+  "Notes": "Notes",
+  "Saved successfully": "Saved successfully",
+  "Deleted successfully": "Deleted successfully",
+  "User": "User",
+  "Period": "Period",
+  "Request limit": "Request limit",
+  "Token limit": "Token limit",
+  "Cost limit": "Cost limit",
+  "Timezone": "Timezone",
+  "Unlimited": "Unlimited",
+  "Add quota": "Add quota",
+  "Edit quota": "Edit quota",
+  "Delete this quota?": "Delete this quota?",
+  "Daily": "Daily",
+  "Monthly": "Monthly",
+  "Reject unpriced models": "Reject unpriced models",
+  "Missing usage behavior": "Missing usage behavior",
+  "Use reserved estimate": "Use reserved estimate",
+  "Allow without token charge": "Allow without token charge",
+  "Started at": "Started at",
+  "Requested model": "Requested model",
+  "Resolved service": "Resolved service",
+  "Resolved model": "Resolved model",
+  "Input tokens": "Input tokens",
+  "Output tokens": "Output tokens",
+  "Total tokens": "Total tokens",
+  "Cost": "Cost",
+  "Cost status": "Cost status",
+  "Request ID": "Request ID",
+  "Failed to load models": "Failed to load models",
+  "Select a model": "Select a model",
+  "Select an AI Employee": "Select an AI Employee",
+  "Usage guide": "Usage guide",
+  "OpenAI-compatible endpoint": "OpenAI-compatible endpoint",
+  "Base URL": "Base URL",
+  "Use a NocoBase API key as the Bearer token.": "Use a NocoBase API key as the Bearer token.",
+  "List available models": "List available models",
+  "Send a chat completion": "Send a chat completion",
+  "Usage filters": "Usage filters",
+  "Time range": "Time range",
+  "User ID": "User ID",
+  "Succeeded": "Succeeded",
+  "Failed": "Failed",
+  "Started": "Started",
+  "Apply filters": "Apply filters",
+  "Reset": "Reset",
+  "Requests": "Requests",
+  "Total cost": "Total cost",
+  "Usage records": "Usage records",
+  "Model metadata": "Model metadata",
+  "Add override": "Add override",
+  "Edit override": "Edit override",
+  "Delete this override?": "Delete this override?",
+  "Context window": "Context window",
+  "Max completion tokens": "Max completion tokens",
+  "Owned by": "Owned by",
+  "Display name": "Display name",
+  "Description": "Description",
+  "Leave empty to not override": "Leave empty to not override",
+  "Total input + output token capacity reported to clients.": "Total input + output token capacity reported to clients.",
+  "Maximum output tokens reported to clients.": "Maximum output tokens reported to clients.",
+  "AI API": "AI API",
+  "Allow this role to use the AI API": "Allow this role to use the AI API",
+  "Allow all AI Employees": "Allow all AI Employees",
+  "Select which AI Employees this role may use:": "Select which AI Employees this role may use:",
+  "Select allowed AI Employees": "Select allowed AI Employees",
+  "Max request body size (MB)": "Max request body size (MB)",
+  "Raise this to accept inline base64 images. Base64 adds about 33% to the original file size.": "Raise this to accept inline base64 images. Base64 adds about 33% to the original file size."
+}

package/src/locale/vi-VN.json

@@ -0,0 +1,105 @@
+{
+  "AI API Gateway": "Cổng AI API",
+  "Configuration": "Cấu hình",
+  "Default AI Employee": "AI Employee mặc định",
+  "Enabled LLM Services": "Dịch vụ LLM được bật",
+  "Rate Limit": "Giới hạn tốc độ",
+  "Save Configuration": "Lưu cấu hình",
+  "Configuration saved": "Đã lưu cấu hình",
+  "Failed to save configuration": "Không thể lưu cấu hình",
+  "API mode": "Chế độ API",
+  "Direct LLM": "LLM trực tiếp",
+  "AI Employee agent": "AI Employee agent",
+  "Default LLM service": "Dịch vụ LLM mặc định",
+  "Enable user quotas": "Bật quota theo người dùng",
+  "Default reserved output tokens": "Số output token giữ chỗ mặc định",
+  "Refresh": "Làm mới",
+  "Model pricing": "Bảng giá model",
+  "User quotas": "Quota người dùng",
+  "Usage": "Lịch sử sử dụng",
+  "LLM service": "Dịch vụ LLM",
+  "Model": "Model",
+  "Input price / 1M": "Giá input / 1 triệu token",
+  "Output price / 1M": "Giá output / 1 triệu token",
+  "Fixed request cost": "Chi phí cố định mỗi request",
+  "Currency": "Tiền tệ",
+  "Status": "Trạng thái",
+  "Enabled": "Đang bật",
+  "Disabled": "Đã tắt",
+  "Actions": "Thao tác",
+  "Edit": "Sửa",
+  "Delete": "Xóa",
+  "Delete this price?": "Xóa cấu hình giá này?",
+  "Add price": "Thêm giá",
+  "Edit price": "Sửa giá",
+  "Effective from": "Hiệu lực từ",
+  "Effective to": "Hiệu lực đến",
+  "Notes": "Ghi chú",
+  "Saved successfully": "Đã lưu thành công",
+  "Deleted successfully": "Đã xóa thành công",
+  "User": "Người dùng",
+  "Period": "Chu kỳ",
+  "Request limit": "Giới hạn request",
+  "Token limit": "Giới hạn token",
+  "Cost limit": "Giới hạn chi phí",
+  "Timezone": "Múi giờ",
+  "Unlimited": "Không giới hạn",
+  "Add quota": "Thêm quota",
+  "Edit quota": "Sửa quota",
+  "Delete this quota?": "Xóa quota này?",
+  "Daily": "Hàng ngày",
+  "Monthly": "Hàng tháng",
+  "Reject unpriced models": "Từ chối model chưa có giá",
+  "Missing usage behavior": "Xử lý khi thiếu token usage",
+  "Use reserved estimate": "Dùng số liệu giữ chỗ để ước tính",
+  "Allow without token charge": "Cho phép và không tính token",
+  "Started at": "Bắt đầu lúc",
+  "Requested model": "Model được yêu cầu",
+  "Resolved service": "Service đã resolve",
+  "Resolved model": "Model đã resolve",
+  "Input tokens": "Input token",
+  "Output tokens": "Output token",
+  "Total tokens": "Tổng token",
+  "Cost": "Chi phí",
+  "Cost status": "Trạng thái chi phí",
+  "Request ID": "Request ID",
+  "Failed to load models": "Không thể tải danh sách model",
+  "Select a model": "Chọn model",
+  "Select an AI Employee": "Chọn AI Employee",
+  "Usage guide": "Hướng dẫn sử dụng",
+  "OpenAI-compatible endpoint": "Endpoint tương thích OpenAI",
+  "Base URL": "Base URL",
+  "Use a NocoBase API key as the Bearer token.": "Sử dụng NocoBase API key làm Bearer token.",
+  "List available models": "Liệt kê model khả dụng",
+  "Send a chat completion": "Gửi yêu cầu chat completion",
+  "Usage filters": "Bộ lọc usage",
+  "Time range": "Khoảng thời gian",
+  "User ID": "User ID",
+  "Succeeded": "Thành công",
+  "Failed": "Thất bại",
+  "Started": "Đã bắt đầu",
+  "Apply filters": "Áp dụng bộ lọc",
+  "Reset": "Đặt lại",
+  "Requests": "Số request",
+  "Total cost": "Tổng chi phí",
+  "Usage records": "Chi tiết usage",
+  "Model metadata": "Metadata model",
+  "Add override": "Thêm override",
+  "Edit override": "Sửa override",
+  "Delete this override?": "Xóa override này?",
+  "Context window": "Context window",
+  "Max completion tokens": "Max completion tokens",
+  "Owned by": "Nhà cung cấp",
+  "Display name": "Tên hiển thị",
+  "Description": "Mô tả",
+  "Leave empty to not override": "Để trống nếu không override",
+  "Total input + output token capacity reported to clients.": "Tổng dung lượng token (input + output) trả về cho client.",
+  "Maximum output tokens reported to clients.": "Số token output tối đa trả về cho client.",
+  "AI API": "AI API",
+  "Allow this role to use the AI API": "Cho phép vai trò này sử dụng AI API",
+  "Allow all AI Employees": "Cho phép tất cả AI Employee",
+  "Select which AI Employees this role may use:": "Chọn AI Employee mà vai trò này được dùng:",
+  "Select allowed AI Employees": "Chọn AI Employee được phép",
+  "Max request body size (MB)": "Giới hạn kích thước request body (MB)",
+  "Raise this to accept inline base64 images. Base64 adds about 33% to the original file size.": "Tăng giá trị này để nhận ảnh base64 gửi trực tiếp. Base64 làm tăng khoảng 33% so với kích thước tệp gốc."
+}