plugin-ai-api 1.0.24 → 1.0.28

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

@@ -1,322 +0,0 @@
-import React, { useCallback, useEffect, useMemo, useState } from 'react';
-import { Alert, Button, Card, Form, 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';
-import type { ApiEnvelope } from './api';
-
-interface UserSummary {
-  id: string | number;
-  nickname?: string;
-  username?: string;
-  email?: string;
-}
-
-interface EnabledLlmService {
-  llmService: string;
-  llmServiceTitle?: string;
-  enabledModels?: { label: string; value: string }[];
-}
-
-interface UserPermission {
-  id: string | number;
-  userId: string | number;
-  user?: UserSummary;
-  enabled: boolean;
-  allowedLlmServices: string[];
-  allowAllModels: boolean;
-  allowedModels: string[];
-}
-
-/** The modal edits everything except the server-assigned id. */
-type UserPermissionFormValues = Omit<UserPermission, 'id' | 'user'>;
-
-const PAGE_SIZE = 20;
-
-export default function UserPermissionsPage() {
-  const ctx = useFlowContext();
-  const t = useT();
-  const [form] = Form.useForm<UserPermissionFormValues>();
-  const selectedServices = Form.useWatch('allowedLlmServices', form);
-  const allowAllModels = Form.useWatch('allowAllModels', form);
-  const [rows, setRows] = useState<UserPermission[]>([]);
-  const [total, setTotal] = useState(0);
-  const [page, setPage] = useState(1);
-  const [users, setUsers] = useState<UserSummary[]>([]);
-  const [userSearch, setUserSearch] = useState('');
-  const [services, setServices] = useState<EnabledLlmService[]>([]);
-  const [loading, setLoading] = useState(false);
-  const [saving, setSaving] = useState(false);
-  const [editing, setEditing] = useState<UserPermission>();
-  const [open, setOpen] = useState(false);
-
-  const load = useCallback(async () => {
-    setLoading(true);
-    try {
-      const [permissionsResponse, servicesResponse] = await Promise.all([
-        ctx.api.request({
-          url: 'aiApiUserPermissions:list',
-          method: 'get',
-          params: { page, pageSize: PAGE_SIZE, appends: ['user'], sort: '-updatedAt' },
-        }),
-        ctx.api.request({ url: 'ai:listAllEnabledModels', method: 'get' }),
-      ]);
-      setRows(unwrapData<UserPermission[]>(permissionsResponse, []));
-      setTotal((permissionsResponse as ApiEnvelope<UserPermission[]>)?.data?.meta?.count ?? 0);
-      setServices(unwrapData<EnabledLlmService[]>(servicesResponse, []));
-    } catch (error) {
-      message.error(errorMessage(error));
-    } finally {
-      setLoading(false);
-    }
-  }, [ctx.api, page]);
-
-  useEffect(() => {
-    load();
-  }, [load]);
-
-  // Served by the plugin's own action rather than `users:list`, which belongs to the
-  // pm.plugin-users snippet and would make this page unusable for a role granted only
-  // pm.plugin-ai-api.user-permissions.
-  const loadUsers = useCallback(
-    async (keyword: string) => {
-      try {
-        const response = await ctx.api.request({
-          url: 'aiApiUserPermissions:listUsers',
-          method: 'get',
-          params: { keyword, pageSize: 50, excludeGranted: !editing },
-        });
-        setUsers(unwrapData<UserSummary[]>(response, []));
-      } catch (error) {
-        message.error(errorMessage(error));
-      }
-    },
-    [ctx.api, editing],
-  );
-
-  useEffect(() => {
-    if (!open) return;
-    const timer = setTimeout(() => loadUsers(userSearch), 300);
-    return () => clearTimeout(timer);
-  }, [open, userSearch, loadUsers]);
-
-  const serviceOptions = useMemo(
-    () =>
-      services.map((service) => ({ label: service.llmServiceTitle || service.llmService, value: service.llmService })),
-    [services],
-  );
-
-  // Model IDs are "serviceName/modelId", matching what the gateway enforces and what
-  // GET /v1/models returns, so admins never have to type them by hand.
-  const modelOptions = useMemo(() => {
-    const picked = new Set(selectedServices || []);
-    return services
-      .filter((service) => picked.has(service.llmService))
-      .flatMap((service) =>
-        (service.enabledModels || []).map((model) => ({
-          label: `${service.llmServiceTitle || service.llmService} / ${model.label || model.value}`,
-          value: `${service.llmService}/${model.value}`,
-        })),
-      );
-  }, [services, selectedServices]);
-
-  const showCreate = () => {
-    setEditing(undefined);
-    setUserSearch('');
-    form.setFieldsValue({
-      enabled: true,
-      allowedLlmServices: [],
-      allowAllModels: true,
-      allowedModels: [],
-    });
-    setOpen(true);
-  };
-
-  const showEdit = (record: UserPermission) => {
-    setEditing(record);
-    setUserSearch('');
-    // Seed the picker with the granted user so the label renders before any search runs.
-    setUsers(record.user ? [record.user] : []);
-    form.setFieldsValue({
-      userId: record.userId,
-      enabled: record.enabled,
-      allowAllModels: record.allowAllModels,
-      allowedLlmServices: record.allowedLlmServices || [],
-      allowedModels: record.allowedModels || [],
-    });
-    setOpen(true);
-  };
-
-  const save = async () => {
-    const values = await form.validateFields();
-    setSaving(true);
-    try {
-      await ctx.api.request({
-        url: editing ? `aiApiUserPermissions:update/${editing.id}` : 'aiApiUserPermissions: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: UserPermission) => {
-    try {
-      await ctx.api.request({ url: `aiApiUserPermissions: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 serviceLabel = (name: string) => serviceOptions.find((option) => option.value === name)?.label || name;
-
-  const columns: ColumnsType<UserPermission> = [
-    {
-      title: t('User'),
-      key: 'user',
-      width: 180,
-      render: (_, record) => userLabel(record.user) || String(record.userId),
-    },
-    {
-      title: t('Allowed LLM services'),
-      dataIndex: 'allowedLlmServices',
-      key: 'allowedLlmServices',
-      render: (values: string[]) =>
-        values?.length ? (
-          <Space size={[0, 4]} wrap>
-            {values.map((value) => (
-              <Tag key={value}>{serviceLabel(value)}</Tag>
-            ))}
-          </Space>
-        ) : (
-          <Tag color="red">{t('No service allowed')}</Tag>
-        ),
-    },
-    {
-      title: t('Allowed models'),
-      key: 'allowedModels',
-      width: 220,
-      render: (_, record) =>
-        record.allowAllModels ? (
-          <Tag color="blue">{t('All models of allowed services')}</Tag>
-        ) : (
-          <Space size={[0, 4]} wrap>
-            {(record.allowedModels || []).map((value) => (
-              <Tag key={value}>{value}</Tag>
-            ))}
-          </Space>
-        ),
-    },
-    {
-      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 permission?')} onConfirm={() => remove(record)}>
-            <Button type="link" danger>
-              {t('Delete')}
-            </Button>
-          </Popconfirm>
-        </Space>
-      ),
-    },
-  ];
-
-  return (
-    <Card
-      title={t('User LLM permissions')}
-      extra={
-        <Button type="primary" onClick={showCreate}>
-          {t('Add permission')}
-        </Button>
-      }
-    >
-      <Alert
-        type="info"
-        showIcon
-        style={{ marginBottom: 16 }}
-        message={t(
-          'Users listed here are limited to the services selected below. Users without a record fall back to the general configuration.',
-        )}
-      />
-      <Table
-        rowKey="id"
-        columns={columns}
-        dataSource={rows}
-        loading={loading}
-        scroll={{ x: 1000 }}
-        pagination={{
-          current: page,
-          pageSize: PAGE_SIZE,
-          total,
-          showSizeChanger: false,
-          onChange: setPage,
-        }}
-      />
-      <Modal
-        title={editing ? t('Edit permission') : t('Add permission')}
-        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
-              // Matching happens on the server, so keep every returned option visible.
-              filterOption={false}
-              onSearch={setUserSearch}
-              notFoundContent={null}
-              options={users.map((user) => ({ label: userLabel(user), value: user.id }))}
-            />
-          </Form.Item>
-          <Form.Item
-            name="allowedLlmServices"
-            label={t('Allowed LLM services')}
-            extra={t('Only services also enabled in the general configuration take effect.')}
-          >
-            <Select mode="multiple" allowClear showSearch optionFilterProp="label" options={serviceOptions} />
-          </Form.Item>
-          <Form.Item name="allowAllModels" label={t('Allow all models')} valuePropName="checked">
-            <Switch />
-          </Form.Item>
-          {allowAllModels === false && (
-            <Form.Item name="allowedModels" label={t('Allowed models')}>
-              <Select mode="multiple" allowClear showSearch optionFilterProp="label" options={modelOptions} />
-            </Form.Item>
-          )}
-          <Form.Item name="enabled" label={t('Enabled')} valuePropName="checked">
-            <Switch />
-          </Form.Item>
-        </Form>
-      </Modal>
-    </Card>
-  );
-}

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

@@ -1,276 +0,0 @@
-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';
-  contextOverflowBehavior: 'reject' | 'truncate';
-}
-
-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',
-      contextOverflowBehavior: 'reject',
-    } 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('Context overflow behavior'),
-      dataIndex: 'contextOverflowBehavior',
-      key: 'contextOverflowBehavior',
-      width: 150,
-      render: (value: QuotaPolicy['contextOverflowBehavior']) =>
-        value === 'truncate' ? t('Truncate oldest conversation turns') : t('Reject request'),
-    },
-    { 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="contextOverflowBehavior" label={t('Context overflow behavior')} rules={[{ required: true }]}>
-            <Select
-              options={[
-                { label: t('Reject request'), value: 'reject' },
-                { label: t('Truncate oldest conversation turns'), value: 'truncate' },
-              ]}
-            />
-          </Form.Item>
-          <Form.Item name="enabled" label={t('Enabled')} valuePropName="checked">
-            <Switch />
-          </Form.Item>
-        </Form>
-      </Modal>
-    </Card>
-  );
-}

package/src/server/__tests__/user-permissions-resource.test.ts

@@ -1,66 +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.
- */
-
-import type { Context, Next } from '@nocobase/actions';
-import { describe, expect, it, vi } from 'vitest';
-import aiApiUserPermissionsResource from '../resource/ai-api-user-permissions';
-
-type ActionHandler = (ctx: Context, next: Next) => Promise<void>;
-
-const listUsers = aiApiUserPermissionsResource.actions?.listUsers as ActionHandler;
-
-function model(values: Record<string, unknown>) {
-  return { get: (key: string) => values[key] };
-}
-
-describe('aiApiUserPermissions:listUsers', () => {
-  it('returns the canonical rows shape for NocoBase data wrapping', async () => {
-    const user = model({
-      id: 7,
-      nickname: 'Ada',
-      username: 'ada',
-      email: 'ada@example.com',
-      password: 'must-not-leak',
-    });
-    const findAndCount = vi.fn(async () => [[user], 1] as const);
-    const ctx = {
-      action: { params: {} },
-      db: { getRepository: () => ({ findAndCount }) },
-    } as unknown as Context;
-
-    await listUsers(ctx, async () => undefined);
-
-    expect(ctx.body).toEqual({
-      rows: [{ id: 7, nickname: 'Ada', username: 'ada', email: 'ada@example.com' }],
-      count: 1,
-      page: 1,
-      pageSize: 50,
-    });
-    expect(findAndCount).toHaveBeenCalledWith(
-      expect.objectContaining({ fields: ['id', 'nickname', 'username', 'email'] }),
-    );
-  });
-
-  it('excludes users that already hold a grant when requested', async () => {
-    const findAndCount = vi.fn(async () => [[], 0] as const);
-    const ctx = {
-      action: { params: { excludeGranted: true } },
-      db: {
-        getRepository: (name: string) =>
-          name === 'aiApiUserPermissions'
-            ? { find: vi.fn(async () => [model({ userId: 3 }), model({ userId: 8 })]) }
-            : { findAndCount },
-      },
-    } as unknown as Context;
-
-    await listUsers(ctx, async () => undefined);
-
-    expect(findAndCount).toHaveBeenCalledWith(expect.objectContaining({ filter: { id: { $notIn: [3, 8] } } }));
-  });
-});