@nocobase/client-v2 2.1.0-beta.22 → 2.1.0-beta.23

package/src/acl/ACLProvider.tsx

@@ -0,0 +1,284 @@
+/**
+ * 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 { observable } from '@formily/reactive';
+import React, { useRef } from 'react';
+import { createContext, useCallback, useContext, useEffect, useMemo, useState, type FC } from 'react';
+import { useLocation } from 'react-router-dom';
+import { useApp } from '../hooks/useApp';
+import { createAclSnippetAllow } from './createAclSnippetAllow';
+
+export type ACLRoleData = {
+  snippets?: string[];
+  role?: string;
+  roleMode?: string;
+  resources?: string[];
+  actions?: Record<string, any>;
+  actionAlias?: Record<string, string>;
+  strategy?: {
+    actions?: string[];
+  };
+  allowAll?: boolean;
+  allowConfigure?: boolean;
+  availableActions?: string[];
+  allowMenuItemIds?: number[];
+  allowAnonymous?: boolean;
+  uiButtonSchemasBlacklist?: string[];
+};
+
+export type ACLMeta = Record<string, any>;
+
+type ACLStore = {
+  data: ACLRoleData;
+  meta: ACLMeta;
+  setData: (data: ACLRoleData) => void;
+  setMeta: (meta: ACLMeta) => void;
+};
+
+type ACLContextValue = {
+  loading: boolean;
+  data: {
+    data: ACLRoleData;
+    meta: ACLMeta;
+  };
+  refresh: () => Promise<void>;
+};
+
+export const ACLContext = createContext<ACLContextValue | null>(null);
+ACLContext.displayName = 'ACLContext';
+
+function createACLStore(): ACLStore {
+  return observable({
+    data: {} as ACLRoleData,
+    meta: {} as ACLMeta,
+    setData(data: ACLRoleData) {
+      this.data = data || {};
+    },
+    setMeta(meta: ACLMeta) {
+      this.meta = meta || {};
+    },
+  });
+}
+
+function ensureACLStore(app: ReturnType<typeof useApp>) {
+  if (!app.context.acl) {
+    app.context.defineProperty('acl', {
+      value: createACLStore(),
+    });
+  }
+
+  return app.context.acl as ACLStore;
+}
+
+/**
+ * 在 v2 中执行 `roles:check`，并把 ACL 数据同步到 app context。
+ */
+export const ACLRolesCheckProvider: FC = ({ children }) => {
+  const app = useApp();
+  const location = useLocation();
+  const aclStore = ensureACLStore(app);
+  const [loading, setLoading] = useState(false);
+  const pathnameRef = useRef(location.pathname);
+  pathnameRef.current = location.pathname;
+
+  const refresh = useCallback(async () => {
+    if (app.router.isSkippedAuthCheckRoute(pathnameRef.current)) {
+      // 认证页等免鉴权路由不需要执行 `roles:check`，避免未登录时产生多余的 401 与 loading 闪烁。
+      setLoading(false);
+      return;
+    }
+
+    const shouldShowLoading = !aclStore.data?.role && !aclStore.data?.snippets?.length;
+    if (shouldShowLoading) {
+      setLoading(true);
+    }
+
+    try {
+      const res = await app.apiClient.request({
+        url: 'roles:check',
+        skipNotify: true,
+        skipAuth: true,
+      });
+
+      const nextData = res?.data?.data || {};
+      const nextMeta = res?.data?.meta || {};
+
+      aclStore.setData(nextData);
+      aclStore.setMeta(nextMeta);
+      app.pluginSettingsManager.setAclSnippets(nextData?.snippets || []);
+
+      if (nextData?.role !== app.apiClient.auth.role) {
+        app.apiClient.auth.setRole(nextData?.role);
+      }
+
+      if (!createAclSnippetAllow(nextData?.snippets || [], !!nextData?.allowAll)('ui.*')) {
+        await app.flowEngine.flowSettings.disable();
+      }
+    } catch (error) {
+      const status = error?.response?.status || error?.status;
+
+      if (status === 401) {
+        aclStore.setData({});
+        aclStore.setMeta({});
+        app.pluginSettingsManager.setAclSnippets([]);
+        app.apiClient.auth.setRole(null);
+        return;
+      }
+
+      console.error(error);
+    } finally {
+      setLoading(false);
+    }
+  }, [aclStore, app]);
+
+  useEffect(() => {
+    void refresh();
+  }, [refresh]);
+
+  const value = useMemo<ACLContextValue>(
+    () => ({
+      loading,
+      data: {
+        data: aclStore.data || {},
+        meta: aclStore.meta || {},
+      },
+      refresh,
+    }),
+    [aclStore.data, aclStore.meta, loading, refresh],
+  );
+
+  if (loading) {
+    return app.renderComponent('AppSpin');
+  }
+
+  return <ACLContext.Provider value={value}>{children}</ACLContext.Provider>;
+};
+
+/**
+ * 返回原始 ACL provider 上下文。
+ */
+export const useACLContext = () => {
+  return useContext(ACLContext);
+};
+
+/**
+ * 触发当前角色权限重新检查。
+ */
+export const useRoleRecheck = () => {
+  const ctx = useACLContext();
+  const { allowAll } = useACLRoleContext();
+
+  return useCallback(() => {
+    if (!ctx || allowAll) {
+      return Promise.resolve();
+    }
+    return ctx.refresh();
+  }, [allowAll, ctx]);
+};
+
+/**
+ * 返回当前角色模式。
+ */
+export const useCurrentRoleMode = () => {
+  const ctx = useACLContext();
+  return ctx?.data?.data?.roleMode;
+};
+
+const useACLRolesCheck = () => {
+  const ctx = useACLContext();
+  const data = ctx?.data?.data || {};
+
+  const getActionAlias = useCallback(
+    (actionPath: string) => {
+      const actionName = actionPath.split(':').pop();
+      return data?.actionAlias?.[actionName || ''] || actionName;
+    },
+    [data?.actionAlias],
+  );
+
+  const inResources = useCallback(
+    (resourceName: string) => {
+      return data?.resources?.includes?.(resourceName);
+    },
+    [data?.resources],
+  );
+
+  const getResourceActionParams = useCallback(
+    (actionPath: string) => {
+      const [resourceName] = actionPath.split(':');
+      const actionAlias = getActionAlias(actionPath);
+      return data?.actions?.[`${resourceName}:${actionAlias}`] || data?.actions?.[actionPath];
+    },
+    [data?.actions, getActionAlias],
+  );
+
+  const getStrategyActionParams = useCallback(
+    (actionPath: string) => {
+      const actionAlias = getActionAlias(actionPath);
+      const strategyAction = data?.strategy?.actions?.find((action) => {
+        const [value] = action.split(':');
+        return value === actionAlias;
+      });
+      return strategyAction ? {} : null;
+    },
+    [data?.strategy?.actions, getActionAlias],
+  );
+
+  return {
+    data,
+    getActionAlias,
+    inResources,
+    getResourceActionParams,
+    getStrategyActionParams,
+  };
+};
+
+/**
+ * 返回当前角色可直接消费的 ACL 数据与动作解析函数。
+ */
+export function useACLRoleContext() {
+  const { data, inResources, getResourceActionParams, getStrategyActionParams } = useACLRolesCheck();
+
+  return {
+    ...data,
+    snippets: data?.snippets || [],
+    parseAction: useCallback(
+      (actionPath: string) => {
+        if (!actionPath) {
+          return null;
+        }
+
+        const [resourceName] = actionPath.split(':');
+
+        if (data?.allowAll) {
+          return {};
+        }
+
+        if (inResources(resourceName)) {
+          return getResourceActionParams(actionPath);
+        }
+
+        return getStrategyActionParams(actionPath);
+      },
+      [data?.allowAll, getResourceActionParams, getStrategyActionParams, inResources],
+    ),
+  };
+}
+
+/**
+ * 返回当前用户是否允许配置界面。
+ */
+export function useUIConfigurationPermissions(): { allowConfigUI: boolean } {
+  const { allowAll, snippets } = useACLRoleContext();
+  const allow = useMemo(() => createAclSnippetAllow(snippets || [], !!allowAll), [allowAll, snippets]);
+
+  return {
+    allowConfigUI: allow('ui.*'),
+  };
+}

package/src/acl/__tests__/createAclSnippetAllow.test.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 { describe, expect, it } from 'vitest';
+import { createAclSnippetAllow } from '../createAclSnippetAllow';
+
+describe('createAclSnippetAllow', () => {
+  it('allows wildcard and empty snippet by default', () => {
+    const allow = createAclSnippetAllow([]);
+
+    expect(allow()).toBe(true);
+    expect(allow('*')).toBe(true);
+  });
+
+  it('matches positive snippets', () => {
+    const allow = createAclSnippetAllow(['ui.*', 'pm']);
+
+    expect(allow('ui.*')).toBe(true);
+    expect(allow('pm')).toBe(true);
+    expect(allow('pm.*')).toBe(false);
+  });
+
+  it('respects negative snippets', () => {
+    const allow = createAclSnippetAllow(['ui.*', '!pm.*']);
+
+    expect(allow('ui.*')).toBe(true);
+    expect(allow('pm.*')).toBe(false);
+  });
+
+  it('allows everything when allowAll is true', () => {
+    const allow = createAclSnippetAllow(['!ui.*'], true);
+
+    expect(allow('ui.*')).toBe(true);
+    expect(allow('pm.*')).toBe(true);
+  });
+});

package/src/acl/createAclSnippetAllow.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 ignore from 'ignore';
+
+/**
+ * 基于 ACL snippets 生成 allow 判定函数。
+ *
+ * @param snippets 当前角色的 snippets 列表
+ * @param allowAll 是否拥有全量权限
+ * @returns 根据 snippet 判断是否允许的函数
+ */
+export const createAclSnippetAllow = (snippets: string[] = [], allowAll = false) => {
+  const ig = ignore().add(snippets || []);
+
+  return (aclSnippet?: string) => {
+    if (!aclSnippet || aclSnippet === '*') {
+      return true;
+    }
+
+    if (allowAll) {
+      return true;
+    }
+
+    return ig.ignores(aclSnippet);
+  };
+};

package/src/acl/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.
+ */
+
+export * from './ACLProvider';
+export * from './createAclSnippetAllow';
+export * from './useAclSnippets';

package/src/acl/useAclSnippets.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { useMemo } from 'react';
+import { useACLRoleContext } from './ACLProvider';
+import { createAclSnippetAllow } from './createAclSnippetAllow';
+
+/**
+ * 返回当前 ACL snippets 的 allow 判定函数。
+ *
+ * @returns 包含 allow 方法的对象
+ */
+export const useAclSnippets = () => {
+  const { allowAll, snippets = [] } = useACLRoleContext();
+
+  const allow = useMemo(() => createAclSnippetAllow(snippets, !!allowAll), [allowAll, snippets]);
+
+  return { allow };
+};

package/src/ai/ai-manager.ts

@@ -0,0 +1,19 @@
+/**
+ * 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 { BaseApplication } from '../BaseApplication';
+import { DefaultToolsManager, ToolsManager } from './tools-manager';
+
+export class AIManager {
+  toolsManager: ToolsManager;
+
+  constructor(protected readonly app: BaseApplication<any>) {
+    this.toolsManager = new DefaultToolsManager(this.app);
+  }
+}

package/src/ai/index.ts

@@ -0,0 +1,13 @@
+/**
+ * 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 './ai-manager';
+export * from './tools-manager';
+export * from './skills-manager';
+export * from './utils';

package/src/ai/skills-manager/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 * from './types';

package/src/ai/skills-manager/types.ts

@@ -0,0 +1,26 @@
+/**
+ * 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 type SkillsScope = 'SPECIFIED' | 'GENERAL' | 'CUSTOM';
+
+export type SkillsEntry = {
+  scope: SkillsScope;
+  name: string;
+  description: string;
+  content?: string;
+  tools?: string[];
+  title?: string;
+  about?: string;
+  from?: string;
+};
+
+export type SkillsFilter = {
+  scope?: SkillsScope;
+  name?: string;
+};

package/src/ai/tools-manager/hooks/context.ts

@@ -0,0 +1,20 @@
+/**
+ * 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, { createContext } from 'react';
+import { ToolsEntry } from '../types';
+
+export interface ToolsContextValue {
+  tools: ToolsEntry[];
+  loading: boolean;
+  error: Error | null;
+  refresh: () => Promise<void>;
+}
+
+export const ToolsContext = createContext<ToolsContextValue | null>(null);

package/src/ai/tools-manager/hooks/index.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 { useContext } from 'react';
+import { ToolsContext } from './context';
+
+export const useTools = () => {
+  const ctx = useContext(ToolsContext);
+  if (!ctx) {
+    throw new Error('useTools must be used within a ToolsProvider');
+  }
+  return ctx;
+};
+
+export * from './context';
+export * from './provider';

package/src/ai/tools-manager/hooks/provider.tsx

@@ -0,0 +1,53 @@
+/**
+ * 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, { ReactNode, useEffect, useState } from 'react';
+import { ToolsEntry, ToolsManager } from '../types';
+import { ToolsContext } from './context';
+
+interface ToolsProviderProps {
+  toolsManager: ToolsManager;
+  children: ReactNode;
+}
+
+export const ToolsProvider: React.FC<ToolsProviderProps> = ({ toolsManager, children }) => {
+  const [tools, setTools] = useState<ToolsEntry[]>([]);
+  const [loading, setLoading] = useState(true);
+  const [error, setError] = useState<Error | null>(null);
+
+  const loadTools = async () => {
+    setLoading(true);
+    setError(null);
+    try {
+      const result = await toolsManager.listTools();
+      setTools(result);
+    } catch (err) {
+      setError(err as Error);
+    } finally {
+      setLoading(false);
+    }
+  };
+
+  useEffect(() => {
+    loadTools();
+  }, []);
+
+  return (
+    <ToolsContext.Provider
+      value={{
+        tools,
+        loading,
+        error,
+        refresh: loadTools,
+      }}
+    >
+      {children}
+    </ToolsContext.Provider>
+  );
+};

package/src/ai/tools-manager/index.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 { Registry } from '@nocobase/utils/client';
+import type { BaseApplication } from '../../BaseApplication';
+import { BackendTools, FrontendTools, ToolsEntry, ToolsFilter, ToolsManager, ToolsOptions } from './types';
+
+export class DefaultToolsManager implements ToolsManager {
+  constructor(
+    protected readonly app: BaseApplication<any>,
+    private readonly tools = new Registry<FrontendTools>(),
+  ) {}
+
+  async listTools(filter?: ToolsFilter): Promise<ToolsEntry[]> {
+    const { data: res } = await this.app.apiClient.resource('aiTools').list({ filter });
+    const backendTools = res?.data as BackendTools[];
+    if (!backendTools) {
+      return [];
+    }
+    return backendTools.map((bt) => ({ ...bt, ...(this.tools.get(bt.definition.name) ?? {}) }));
+  }
+
+  useTools(): Registry<FrontendTools> {
+    const register = new Registry<FrontendTools>();
+    for (const [key, value] of this.tools.getEntities()) {
+      register.register(key, { ...(value.useHooks?.() ?? value) } as FrontendTools);
+    }
+    return register;
+  }
+
+  registerTools(name: string, options: ToolsOptions): void {
+    this.tools.register(name, { ...options } as FrontendTools);
+  }
+}
+
+export * from './types';