plugin-ai-api 1.0.3 → 1.0.4

package/src/client/client.d.ts

@@ -0,0 +1,258 @@
+/**
+ * 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.
+ */
+
+/**
+ * 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.
+ */
+
+// CSS modules
+type CSSModuleClasses = { readonly [key: string]: string };
+
+declare module '*.module.css' {
+  const classes: CSSModuleClasses;
+  export default classes;
+}
+declare module '*.module.scss' {
+  const classes: CSSModuleClasses;
+  export default classes;
+}
+declare module '*.module.sass' {
+  const classes: CSSModuleClasses;
+  export default classes;
+}
+declare module '*.module.less' {
+  const classes: CSSModuleClasses;
+  export default classes;
+}
+declare module '*.module.styl' {
+  const classes: CSSModuleClasses;
+  export default classes;
+}
+declare module '*.module.stylus' {
+  const classes: CSSModuleClasses;
+  export default classes;
+}
+declare module '*.module.pcss' {
+  const classes: CSSModuleClasses;
+  export default classes;
+}
+declare module '*.module.sss' {
+  const classes: CSSModuleClasses;
+  export default classes;
+}
+
+// CSS
+declare module '*.css' { }
+declare module '*.scss' { }
+declare module '*.sass' { }
+declare module '*.less' { }
+declare module '*.styl' { }
+declare module '*.stylus' { }
+declare module '*.pcss' { }
+declare module '*.sss' { }
+
+// Built-in asset types
+// see `src/node/constants.ts`
+
+// images
+declare module '*.apng' {
+  const src: string;
+  export default src;
+}
+declare module '*.png' {
+  const src: string;
+  export default src;
+}
+declare module '*.jpg' {
+  const src: string;
+  export default src;
+}
+declare module '*.jpeg' {
+  const src: string;
+  export default src;
+}
+declare module '*.jfif' {
+  const src: string;
+  export default src;
+}
+declare module '*.pjpeg' {
+  const src: string;
+  export default src;
+}
+declare module '*.pjp' {
+  const src: string;
+  export default src;
+}
+declare module '*.gif' {
+  const src: string;
+  export default src;
+}
+declare module '*.svg' {
+  const src: string;
+  export default src;
+}
+declare module '*.ico' {
+  const src: string;
+  export default src;
+}
+declare module '*.webp' {
+  const src: string;
+  export default src;
+}
+declare module '*.avif' {
+  const src: string;
+  export default src;
+}
+
+// media
+declare module '*.mp4' {
+  const src: string;
+  export default src;
+}
+declare module '*.webm' {
+  const src: string;
+  export default src;
+}
+declare module '*.ogg' {
+  const src: string;
+  export default src;
+}
+declare module '*.mp3' {
+  const src: string;
+  export default src;
+}
+declare module '*.wav' {
+  const src: string;
+  export default src;
+}
+declare module '*.flac' {
+  const src: string;
+  export default src;
+}
+declare module '*.aac' {
+  const src: string;
+  export default src;
+}
+declare module '*.opus' {
+  const src: string;
+  export default src;
+}
+declare module '*.mov' {
+  const src: string;
+  export default src;
+}
+declare module '*.m4a' {
+  const src: string;
+  export default src;
+}
+declare module '*.vtt' {
+  const src: string;
+  export default src;
+}
+
+// fonts
+declare module '*.woff' {
+  const src: string;
+  export default src;
+}
+declare module '*.woff2' {
+  const src: string;
+  export default src;
+}
+declare module '*.eot' {
+  const src: string;
+  export default src;
+}
+declare module '*.ttf' {
+  const src: string;
+  export default src;
+}
+declare module '*.otf' {
+  const src: string;
+  export default src;
+}
+
+// other
+declare module '*.webmanifest' {
+  const src: string;
+  export default src;
+}
+declare module '*.pdf' {
+  const src: string;
+  export default src;
+}
+declare module '*.txt' {
+  const src: string;
+  export default src;
+}
+
+// wasm?init
+declare module '*.wasm?init' {
+  const initWasm: (options?: WebAssembly.Imports) => Promise<WebAssembly.Instance>;
+  export default initWasm;
+}
+
+// web worker
+declare module '*?worker' {
+  const workerConstructor: {
+    new(options?: { name?: string }): Worker;
+  };
+  export default workerConstructor;
+}
+
+declare module '*?worker&inline' {
+  const workerConstructor: {
+    new(options?: { name?: string }): Worker;
+  };
+  export default workerConstructor;
+}
+
+declare module '*?worker&url' {
+  const src: string;
+  export default src;
+}
+
+declare module '*?sharedworker' {
+  const sharedWorkerConstructor: {
+    new(options?: { name?: string }): SharedWorker;
+  };
+  export default sharedWorkerConstructor;
+}
+
+declare module '*?sharedworker&inline' {
+  const sharedWorkerConstructor: {
+    new(options?: { name?: string }): SharedWorker;
+  };
+  export default sharedWorkerConstructor;
+}
+
+declare module '*?sharedworker&url' {
+  const src: string;
+  export default src;
+}
+
+declare module '*?raw' {
+  const src: string;
+  export default src;
+}
+
+declare module '*?url' {
+  const src: string;
+  export default src;
+}
+
+declare module '*?inline' {
+  const src: string;
+  export default src;
+}

package/src/client/components/AiApiRolePermissions.tsx

@@ -0,0 +1,169 @@
+/**
+ * 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 React, { useEffect, useState } from 'react';
+import { useAPIClient } from '@nocobase/client';
+import { Card, Switch, Select, Space, Typography, Spin, Divider } from 'antd';
+
+const { Text } = Typography;
+
+interface AiEmployee {
+  username: string;
+  nickname: string;
+}
+
+interface RolePermRecord {
+  id?: number;
+  roleName: string;
+  enabled: boolean;
+  allowAllEmployees: boolean;
+  allowedEmployees: string[];
+}
+
+/**
+ * Permission tab shown in Settings → Users & Permissions → [Role] → "AI API" tab.
+ * Lets admins control whether a role can use the AI API and which AI Employees it may access.
+ */
+export function AiApiRolePermissions({ role }: { role: any }) {
+  const api = useAPIClient();
+  const [loading, setLoading] = useState(true);
+  const [saving, setSaving] = useState(false);
+  const [employees, setEmployees] = useState<AiEmployee[]>([]);
+  const [record, setRecord] = useState<RolePermRecord | null>(null);
+
+  const roleName = role?.name;
+
+  useEffect(() => {
+    if (!roleName) return;
+    loadData();
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [roleName]);
+
+  const loadData = async () => {
+    setLoading(true);
+    try {
+      const [permRes, empRes] = await Promise.all([
+        api.request({
+          url: 'aiApiRolePermissions',
+          params: { filter: { roleName }, paginate: false },
+        }),
+        api.request({ url: 'aiEmployees:list', params: { paginate: false } }),
+      ]);
+
+      const existing = permRes?.data?.data?.[0];
+      setRecord(
+        existing
+          ? {
+              id: existing.id,
+              roleName: existing.roleName,
+              enabled: !!existing.enabled,
+              allowAllEmployees: existing.allowAllEmployees !== false,
+              allowedEmployees: existing.allowedEmployees || [],
+            }
+          : {
+              roleName,
+              enabled: false,
+              allowAllEmployees: true,
+              allowedEmployees: [],
+            },
+      );
+
+      setEmployees(
+        (empRes?.data?.data || []).map((e: any) => ({
+          username: e.username,
+          nickname: e.nickname || e.username,
+        })),
+      );
+    } catch (err) {
+      console.error('Failed to load AI API role permissions:', err);
+    } finally {
+      setLoading(false);
+    }
+  };
+
+  const save = async (patch: Partial<RolePermRecord>) => {
+    if (!record) return;
+    const next = { ...record, ...patch };
+    setRecord(next);
+    setSaving(true);
+    try {
+      if (next.id) {
+        await api.request({
+          url: `aiApiRolePermissions/${next.id}`,
+          method: 'PUT',
+          data: next,
+        });
+      } else {
+        const res = await api.request({
+          url: 'aiApiRolePermissions',
+          method: 'POST',
+          data: next,
+        });
+        const created = res?.data?.data;
+        if (created?.id) {
+          setRecord({ ...next, id: created.id });
+        }
+      }
+    } catch (err) {
+      console.error('Failed to save AI API role permissions:', err);
+      // Revert on error
+      setRecord(record);
+    } finally {
+      setSaving(false);
+    }
+  };
+
+  if (loading) return <Spin />;
+
+  return (
+    <Card bordered={false}>
+      <Space direction="vertical" style={{ width: '100%' }} size="middle">
+        <Space>
+          <Switch checked={!!record?.enabled} loading={saving} onChange={(checked) => save({ enabled: checked })} />
+          <Text strong>Allow this role to use the AI API</Text>
+        </Space>
+
+        {record?.enabled && (
+          <>
+            <Divider style={{ margin: '8px 0' }} />
+            <Space>
+              <Switch
+                checked={!!record?.allowAllEmployees}
+                loading={saving}
+                onChange={(checked) => save({ allowAllEmployees: checked })}
+              />
+              <Text>Allow all AI Employees</Text>
+            </Space>
+
+            {!record?.allowAllEmployees && (
+              <div>
+                <Text type="secondary" style={{ display: 'block', marginBottom: 8 }}>
+                  Select which AI Employees this role may use:
+                </Text>
+                <Select
+                  mode="multiple"
+                  allowClear
+                  style={{ width: '100%', maxWidth: 480 }}
+                  placeholder="Select allowed AI Employees"
+                  value={record?.allowedEmployees || []}
+                  options={employees.map((e) => ({
+                    label: `${e.nickname} (${e.username})`,
+                    value: e.username,
+                  }))}
+                  onChange={(vals) => save({ allowedEmployees: vals })}
+                  disabled={saving}
+                />
+              </div>
+            )}
+          </>
+        )}
+      </Space>
+    </Card>
+  );
+}

package/src/client/index.tsx

@@ -0,0 +1,10 @@
+/**
+ * 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 { default } from './plugin';

package/src/client/locale.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.
+ */
+
+import { tExpr as _tExpr, useFlowEngine } from '@nocobase/flow-engine';
+// @ts-ignore
+import pkg from './../../package.json';
+
+export function useT() {
+  const engine = useFlowEngine();
+  return (str: string) => engine.context.t(str, { ns: [pkg.name, 'client'] });
+}
+
+export function tExpr(key: string) {
+  return _tExpr(key, { ns: [pkg.name, 'client'] });
+}

package/src/client/models/index.ts

@@ -0,0 +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.
+ */
+
+import { ModelConstructor } from '@nocobase/flow-engine';
+
+export default {} as Record<string, ModelConstructor>;

package/src/client/plugin.tsx

@@ -0,0 +1,48 @@
+/**
+ * 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 { Plugin, lazy } from '@nocobase/client';
+import PluginACLClient from '@nocobase/plugin-acl/client';
+import React from 'react';
+
+const AiApiConfigPage = React.lazy(() => import('./AiApiConfigPage'));
+const { AiApiRolePermissions } = lazy(() => import('./components/AiApiRolePermissions'), 'AiApiRolePermissions');
+
+export class PluginAiApiClient extends Plugin {
+  async load() {
+    this.app.pluginSettingsManager.add('ai-api', {
+      icon: 'ApiOutlined',
+      title: this.t('AI API Gateway'),
+      aclSnippet: 'pm.ai-api.configuration',
+    });
+
+    this.app.pluginSettingsManager.add('ai-api.config', {
+      title: this.t('Configuration'),
+      Component: AiApiConfigPage,
+    });
+
+    // Add "AI API" tab in Settings → Users & Permissions → [Role]
+    const aclPlugin = this.app.pm.get(PluginACLClient);
+    if (aclPlugin?.settingsUI) {
+      aclPlugin.settingsUI.addPermissionsTab(({ t, TabLayout, activeRole }) => ({
+        key: 'aiApi',
+        label: 'AI API',
+        sort: 25,
+        children: (
+          <TabLayout>
+            <AiApiRolePermissions role={activeRole} />
+          </TabLayout>
+        ),
+      }));
+    }
+  }
+
+}
+
+export default PluginAiApiClient;

package/src/client-v2/index.tsx

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

package/src/client-v2/plugin.tsx

@@ -0,0 +1,24 @@
+import { Plugin, Application } from '@nocobase/client-v2';
+import React from 'react';
+
+export class PluginAiApiClient extends Plugin<Record<string, never>, Application> {
+  async load() {
+    this.pluginSettingsManager.addMenuItem({
+      key: 'ai-api',
+      title: this.t('AI API Gateway'),
+      icon: 'ApiOutlined',
+      aclSnippet: 'pm.ai-api.configuration',
+    });
+
+    this.pluginSettingsManager.addPageTabItem({
+      menuKey: 'ai-api',
+      key: 'index',
+      title: this.t('Configuration'),
+      
+      componentLoader: () => import('../client/AiApiConfigPage'),
+    });
+
+  }
+}
+
+export default PluginAiApiClient;

package/src/index.ts

@@ -0,0 +1,11 @@
+/**
+ * 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 * from './server';
+export { default } from './server';

package/src/locale/en-US.json

@@ -0,0 +1,10 @@
+{
+  "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"
+}

package/src/locale/zh-CN.json

@@ -0,0 +1,10 @@
+{
+  "AI API Gateway": "AI API 网关",
+  "Configuration": "配置",
+  "Default AI Employee": "默认 AI 员工",
+  "Enabled LLM Services": "已启用 LLM 服务",
+  "Rate Limit": "速率限制",
+  "Save Configuration": "保存配置",
+  "Configuration saved": "配置已保存",
+  "Failed to save configuration": "保存配置失败"
+}

package/src/server/collections/ai-api-config.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 { defineCollection } from '@nocobase/database';
+
+export default defineCollection({
+  name: 'aiApiConfig',
+  autoGenId: true,
+  fields: [
+    {
+      name: 'mode',
+      type: 'string',
+      defaultValue: 'llm',
+      comment: "API mode: 'llm' = direct LLM proxy, 'agent' = full AI Employee agent with tools/RAG",
+    },
+    {
+      name: 'defaultAiEmployee',
+      type: 'string',
+      comment: 'Username of the default AI Employee for system prompt injection',
+    },
+    {
+      name: 'defaultLlmService',
+      type: 'string',
+      comment: 'Name (UID) of the default LLM service. Clients can send just modelId without service prefix.',
+    },
+    {
+      name: 'enabledLlmServices',
+      type: 'json',
+      defaultValue: [],
+      comment: 'Array of llmService names to expose. Empty = expose all enabled services',
+    },
+    {
+      name: 'rateLimitPerMinute',
+      type: 'integer',
+      defaultValue: 60,
+      comment: 'Max requests per user per minute',
+    },
+    {
+      name: 'options',
+      type: 'jsonb',
+      defaultValue: {},
+      comment: 'Reserved for future extensibility',
+    },
+  ],
+});

package/src/server/collections/ai-api-role-permissions.ts

@@ -0,0 +1,41 @@
+/**
+ * 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 { defineCollection } from '@nocobase/database';
+
+export default defineCollection({
+  name: 'aiApiRolePermissions',
+  autoGenId: true,
+  fields: [
+    {
+      name: 'roleName',
+      type: 'string',
+      unique: true,
+      comment: 'Role name (links to roles.name)',
+    },
+    {
+      name: 'enabled',
+      type: 'boolean',
+      defaultValue: false,
+      comment: 'Whether this role can use the AI API at all',
+    },
+    {
+      name: 'allowAllEmployees',
+      type: 'boolean',
+      defaultValue: true,
+      comment: 'If true, the role may use any AI Employee. If false, only those in allowedEmployees.',
+    },
+    {
+      name: 'allowedEmployees',
+      type: 'json',
+      defaultValue: [],
+      comment: 'Array of AI Employee usernames this role is allowed to use (when allowAllEmployees=false)',
+    },
+  ],
+});

package/src/server/index.ts

@@ -0,0 +1,10 @@
+/**
+ * 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 { default } from './plugin';