@nocobase/client-v2 2.1.0-alpha.3 → 2.1.0-alpha.30

package/es/ai/tools-manager/index.d.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 { Registry } from '@nocobase/utils/client';
+import type { BaseApplication } from '../../BaseApplication';
+import { FrontendTools, ToolsEntry, ToolsFilter, ToolsManager, ToolsOptions } from './types';
+export declare class DefaultToolsManager implements ToolsManager {
+    protected readonly app: BaseApplication<any>;
+    private readonly tools;
+    constructor(app: BaseApplication<any>, tools?: any);
+    listTools(filter?: ToolsFilter): Promise<ToolsEntry[]>;
+    useTools(): Registry<FrontendTools>;
+    registerTools(name: string, options: ToolsOptions): void;
+}
+export * from './types';

package/es/ai/tools-manager/types.d.ts

@@ -0,0 +1,90 @@
+/**
+ * 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 { ComponentType } from 'react';
+import type { ModalProps } from 'antd';
+import { Registry } from '@nocobase/utils/client';
+import type { BaseApplication } from '../../BaseApplication';
+export interface ToolsManager extends ToolsRegistration {
+    listTools(filter?: ToolsFilter): Promise<ToolsEntry[]>;
+    useTools(): Registry<FrontendTools>;
+}
+export interface ToolsRegistration {
+    registerTools(name: string, options: ToolsOptions): void;
+}
+export type ToolModalProps = Pick<ModalProps, 'width' | 'styles'>;
+export type ToolsOptions = {
+    ui?: {
+        card?: ComponentType<ToolsUIProperties>;
+        modal?: {
+            title?: string;
+            okText?: string;
+            props?: ToolModalProps;
+            footer?: ComponentType<{
+                tool: ToolCall;
+            }>;
+            hideOkButton?: boolean;
+            useOnOk?: (decisions: ToolsUIProperties['decisions'], adjustArgs: Record<string, any>) => {
+                onOk: () => void | Promise<void>;
+            };
+            Component?: ComponentType<{
+                tool: ToolCall;
+                saveToolArgs?: (args: unknown) => Promise<void>;
+            }>;
+        };
+    };
+    invoke?: (ctx: BaseApplication<any>, params: any) => any | Promise<any>;
+    useHooks?: () => ToolsOptions;
+};
+export type ToolCall<T = unknown> = {
+    id: string;
+    type: string;
+    name: string;
+    status?: 'success' | 'error';
+    invokeStatus: 'init' | 'interrupted' | 'waiting' | 'pending' | 'done' | 'confirmed';
+    auto: boolean;
+    args: T;
+    [key: string]: any;
+};
+export type FrontendTools = ToolsOptions;
+export type BackendTools = {
+    scope: Scope;
+    from: From;
+    defaultPermission?: Permission;
+    silence?: boolean;
+    introduction?: {
+        title: string;
+        about: string;
+    };
+    definition: {
+        name: string;
+        description: string;
+        schema?: any;
+    };
+};
+export type ToolsEntry = BackendTools & FrontendTools;
+export type ToolsUIProperties<ToolCallArgs = unknown> = {
+    messageId: string;
+    tools: ToolsEntry;
+    toolCall: ToolCall<ToolCallArgs>;
+    decisions: DecisionActions;
+};
+export type DecisionActions = {
+    approve: () => Promise<void>;
+    edit: (args: any) => Promise<void>;
+    reject: (message?: string) => Promise<void>;
+};
+export type ToolsFilter = {
+    scope?: Scope;
+    defaultPermission?: Permission;
+    silence?: boolean;
+    sessionId?: string;
+};
+export type Scope = 'SPECIFIED' | 'GENERAL' | 'CUSTOM';
+export type Permission = 'ASK' | 'ALLOW';
+export type From = 'loader' | 'workflow' | 'mcp';

package/es/ai/utils.d.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.
+ */
+import { ToolsEntry } from './tools-manager';
+export declare const toToolsMap: (tools: ToolsEntry[]) => Map<string, ToolsEntry>;

package/es/authRedirect.d.ts

@@ -0,0 +1,63 @@
+/**
+ * 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';
+type AppLike = Pick<BaseApplication<any>, 'getPublicPath'> & {
+    router?: {
+        getBasename?: () => string | undefined;
+    };
+};
+type LocationLike = {
+    pathname: string;
+    search?: string;
+    hash?: string;
+};
+declare function getDefaultV2AdminRedirectPath(app: AppLike): string;
+/**
+ * 将 v2 admin 路径转换为对应的 v1 admin 根相对路径。
+ *
+ * @param app 当前 v2 应用实例
+ * @param value 当前 v2 admin 路径或 location 对象
+ * @returns 对应的 v1 admin 根相对路径；若无法安全转换则返回 null
+ */
+export declare function convertV2AdminPathToLegacy(app: AppLike, value: string | LocationLike): string;
+/**
+ * 将当前 v2 页面地址转换为根相对 redirect 路径。
+ *
+ * @param app 当前 v2 应用实例
+ * @param locationLike 当前路由地址
+ * @returns 根相对的 v2 redirect
+ */
+export declare function getCurrentV2RedirectPath(app: AppLike, locationLike: LocationLike): string;
+/**
+ * 构造跳转到 v1 登录页的完整 href。
+ *
+ * @param app 当前 v2 应用实例
+ * @param targetPath 登录后回跳地址
+ * @returns 指向 v1 登录页的 href
+ */
+export declare function buildLegacySigninHref(app: AppLike, targetPath: string): string;
+/**
+ * 通过整页跳转进入 v1 登录页。
+ *
+ * @param app 当前 v2 应用实例
+ * @param targetPath 登录后回跳地址
+ * @param options 跳转选项
+ */
+export declare function redirectToLegacySignin(app: AppLike, targetPath: string, options?: {
+    replace?: boolean;
+}): void;
+/**
+ * 解析并校验服务端返回的 v1 登录页地址。
+ *
+ * @param value 服务端返回的 redirect
+ * @param app 当前 v2 应用实例
+ * @returns 合法时返回完整同源 URL，否则返回 null
+ */
+export declare function resolveLegacySigninRedirect(value: string | undefined | null, app: AppLike): string;
+export { getDefaultV2AdminRedirectPath };

package/es/collection-field-interface/CollectionFieldInterface.d.ts

@@ -0,0 +1,71 @@
+/**
+ * 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 { ISchema } from '@formily/react';
+import { CollectionFieldInterfaceManager } from './CollectionFieldInterfaceManager';
+export type CollectionFieldInterfaceFactory = new (collectionFieldInterfaceManager: CollectionFieldInterfaceManager) => CollectionFieldInterface;
+export interface CollectionFieldInterfaceComponentOption {
+    label: string;
+    value: string;
+    useVisible?: () => boolean;
+    useProps?: () => any;
+}
+export declare abstract class CollectionFieldInterface {
+    collectionFieldInterfaceManager: CollectionFieldInterfaceManager;
+    constructor(collectionFieldInterfaceManager: CollectionFieldInterfaceManager);
+    name: string;
+    group: string;
+    title?: string;
+    description?: string;
+    primaryKeyDescription?: string;
+    order?: number;
+    default?: {
+        type: string;
+        uiSchema?: ISchema;
+        [key: string]: any;
+    };
+    sortable?: boolean;
+    availableTypes?: string[];
+    type?: string;
+    supportDataSourceType?: string[];
+    notSupportDataSourceType?: string[];
+    hasDefaultValue?: boolean;
+    componentOptions?: CollectionFieldInterfaceComponentOption[];
+    isAssociation?: boolean;
+    operators?: any[];
+    properties?: any;
+    validationType?: string;
+    availableValidationOptions: string[];
+    excludeValidationOptions?: string[];
+    /**
+     * - 如果该值为空，则在 Filter 组件中该字段会被过滤掉
+     * - 如果该值为空，则不会在变量列表中看到该字段
+     */
+    filterable?: {
+        /**
+         * 字段所支持的操作符，会在 Filter 组件中显示，比如设置 `数据范围` 的时候可以看见
+         */
+        operators?: any[];
+        /**
+         * 为当前字段添加子选项，这个子选项会在 Filter 组件中显示，比如设置 `数据范围` 的时候可以看见
+         */
+        children?: any[];
+        [key: string]: any;
+    };
+    titleUsable?: boolean;
+    validateSchema?(fieldSchema: ISchema): Record<string, ISchema>;
+    usePathOptions?(field: any): any;
+    schemaInitialize?(schema: ISchema, data: any): void;
+    hidden?: boolean;
+    addComponentOption(componentOption: CollectionFieldInterfaceComponentOption): void;
+    getConfigureFormProperties(collectionInfo?: any): Record<string, ISchema>;
+    getDefaultValueProperty(): {
+        defaultValue: any;
+    };
+    addOperator(operatorOption: any): void;
+}

package/es/collection-field-interface/CollectionFieldInterfaceManager.d.ts

@@ -0,0 +1,109 @@
+/**
+ * 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.
+ */
+interface FieldInterfaceLike {
+    name?: string;
+    supportDataSourceType?: string[];
+    notSupportDataSourceType?: string[];
+    addComponentOption?: (option: any) => void;
+    addOperator?: (option: any) => void;
+}
+interface PendingAction {
+    type: 'addComponentOption' | 'addOperator';
+    data: any;
+}
+/**
+ * 提供 client-v2 运行时所需的字段接口注册能力。
+ *
+ * 该管理器只保留运行时消费所需的最小行为：
+ * 注册字段接口、分组、组件选项和操作符，并支持后注册的接口回放待处理动作。
+ *
+ * @example
+ * ```typescript
+ * const manager = new CollectionFieldInterfaceManager(dataSourceManager);
+ * manager.addFieldInterfaces([InputFieldInterface]);
+ * ```
+ */
+export declare class CollectionFieldInterfaceManager {
+    dataSourceManager: any;
+    protected collectionFieldInterfaceInstances: Record<string, FieldInterfaceLike>;
+    protected collectionFieldGroups: Record<string, {
+        label: string;
+        order?: number;
+    }>;
+    protected actionList: Record<string, PendingAction[]>;
+    constructor(dataSourceManager: any);
+    /**
+     * 注册字段接口类。
+     *
+     * @param fieldInterfaceClasses 字段接口类列表
+     * @returns void
+     */
+    addFieldInterfaces(fieldInterfaceClasses?: Array<new (manager: CollectionFieldInterfaceManager) => FieldInterfaceLike>): void;
+    /**
+     * 为字段接口补充组件选项。
+     *
+     * @param interfaceName 字段接口名
+     * @param componentOption 组件选项
+     * @returns void
+     */
+    addFieldInterfaceComponentOption(interfaceName: string, componentOption: any): void;
+    /**
+     * 为字段接口补充操作符。
+     *
+     * @param name 字段接口名
+     * @param operatorOption 操作符配置
+     * @returns void
+     */
+    addFieldInterfaceOperator(name: string, operatorOption: any): void;
+    /**
+     * 获取单个字段接口实例。
+     *
+     * @param name 字段接口名
+     * @returns 字段接口实例
+     */
+    getFieldInterface<T = FieldInterfaceLike>(name: string): T;
+    /**
+     * 获取全部字段接口实例。
+     *
+     * @param dataSourceType 可选的数据源类型过滤
+     * @returns 字段接口实例列表
+     */
+    getFieldInterfaces<T = FieldInterfaceLike>(dataSourceType?: string): T[];
+    /**
+     * 注册字段接口分组。
+     *
+     * @param groups 分组配置
+     * @returns void
+     */
+    addFieldInterfaceGroups(groups?: Record<string, {
+        label: string;
+        order?: number;
+    }>): void;
+    /**
+     * 获取全部字段接口分组。
+     *
+     * @returns 字段接口分组映射
+     */
+    getFieldInterfaceGroups(): Record<string, {
+        label: string;
+        order?: number;
+    }>;
+    /**
+     * 获取单个字段接口分组。
+     *
+     * @param name 分组名
+     * @returns 分组配置
+     */
+    getFieldInterfaceGroup(name: string): {
+        label: string;
+        order?: number;
+    };
+    protected enqueueAction(interfaceName: string, action: PendingAction): void;
+}
+export {};

package/es/collection-manager/interfaces/checkbox.d.ts

@@ -0,0 +1,87 @@
+/**
+ * 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 { ISchema } from '@formily/react';
+import { CollectionFieldInterface } from '../../collection-field-interface/CollectionFieldInterface';
+export declare class CheckboxFieldInterface extends CollectionFieldInterface {
+    name: string;
+    type: string;
+    group: string;
+    order: number;
+    title: string;
+    default: {
+        type: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+        };
+    };
+    availableTypes: string[];
+    hasDefaultValue: boolean;
+    properties: {
+        'uiSchema.title': {
+            type: string;
+            title: string;
+            required: boolean;
+            'x-decorator': string;
+            'x-component': string;
+        };
+        name: {
+            type: string;
+            title: string;
+            required: boolean;
+            'x-disabled': string;
+            'x-decorator': string;
+            'x-component': string;
+            'x-validator': string;
+            description: string;
+        };
+    };
+    filterable: {
+        operators: ({
+            label: string;
+            value: string;
+            selected: boolean;
+            noValue: boolean;
+            schema: {
+                'x-component': string;
+                'x-component-props': {
+                    multiple: boolean;
+                    options: {
+                        label: string;
+                        value: boolean;
+                    }[];
+                };
+            };
+        } | {
+            label: string;
+            value: string;
+            noValue: boolean;
+            schema: {
+                'x-component': string;
+                'x-component-props': {
+                    multiple: boolean;
+                    options: {
+                        label: string;
+                        value: boolean;
+                    }[];
+                };
+            };
+            selected?: undefined;
+        } | {
+            label: string;
+            value: string;
+            noValue: boolean;
+            selected?: undefined;
+            schema?: undefined;
+        })[];
+    };
+    schemaInitialize(schema: ISchema, { block }: {
+        block: string;
+    }): void;
+}

package/es/collection-manager/interfaces/checkboxGroup.d.ts

@@ -0,0 +1,138 @@
+/**
+ * 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 { ISchema } from '@formily/react';
+import { CollectionFieldInterface } from '../../collection-field-interface/CollectionFieldInterface';
+export declare class CheckboxGroupFieldInterface extends CollectionFieldInterface {
+    name: string;
+    type: string;
+    group: string;
+    order: number;
+    title: string;
+    default: {
+        interface: string;
+        type: string;
+        defaultValue: any[];
+        uiSchema: {
+            type: string;
+            'x-component': string;
+        };
+    };
+    availableTypes: string[];
+    hasDefaultValue: boolean;
+    properties: {
+        'uiSchema.enum': import("@formily/react").Stringify<{
+            [key: symbol]: any;
+            [key: `x-${string}`]: any;
+            [key: `x-${number}`]: any;
+            version?: string;
+            name?: import("@formily/react").SchemaKey;
+            title?: any;
+            description?: any;
+            default?: any;
+            readOnly?: boolean;
+            writeOnly?: boolean;
+            type?: import("@formily/react").SchemaTypes;
+            enum?: import("@formily/react").SchemaEnum<any>;
+            const?: any;
+            multipleOf?: number;
+            maximum?: number;
+            exclusiveMaximum?: number;
+            minimum?: number;
+            exclusiveMinimum?: number;
+            maxLength?: number;
+            minLength?: number;
+            pattern?: string | RegExp;
+            maxItems?: number;
+            minItems?: number;
+            uniqueItems?: boolean;
+            maxProperties?: number;
+            minProperties?: number;
+            required?: string | boolean | string[];
+            format?: string;
+            $ref?: string;
+            $namespace?: string;
+            definitions?: import("@formily/react").SchemaProperties<any, any, any, any, any, any, any, any>;
+            properties?: import("@formily/react").SchemaProperties<any, any, any, any, any, any, any, any>;
+            items?: import("@formily/react").SchemaItems<any, any, any, any, any, any, any, any>;
+            additionalItems?: import("@formily/react").Stringify<any>;
+            patternProperties?: import("@formily/react").SchemaProperties<any, any, any, any, any, any, any, any>;
+            additionalProperties?: import("@formily/react").Stringify<any>;
+            "x-value"?: any;
+            "x-index"?: number;
+            "x-pattern"?: any;
+            "x-display"?: any;
+            "x-validator"?: any;
+            "x-decorator"?: any;
+            "x-decorator-props"?: any;
+            "x-component"?: any;
+            "x-component-props"?: any;
+            "x-reactions"?: import("@formily/react").SchemaReactions<any>;
+            "x-content"?: any;
+            "x-data"?: any;
+            "x-visible"?: boolean;
+            "x-hidden"?: boolean;
+            "x-disabled"?: boolean;
+            "x-editable"?: boolean;
+            "x-read-only"?: boolean;
+            "x-read-pretty"?: boolean;
+            "x-compile-omitted"?: string[];
+        }>;
+        'uiSchema.title': {
+            type: string;
+            title: string;
+            required: boolean;
+            'x-decorator': string;
+            'x-component': string;
+        };
+        name: {
+            type: string;
+            title: string;
+            required: boolean;
+            'x-disabled': string;
+            'x-decorator': string;
+            'x-component': string;
+            'x-validator': string;
+            description: string;
+        };
+    };
+    filterable: {
+        operators: ({
+            label: string;
+            value: string;
+            selected: boolean;
+            schema: {
+                'x-component': string;
+                'x-component-props': {
+                    mode: string;
+                };
+            };
+            noValue?: undefined;
+        } | {
+            label: string;
+            value: string;
+            schema: {
+                'x-component': string;
+                'x-component-props': {
+                    mode: string;
+                };
+            };
+            selected?: undefined;
+            noValue?: undefined;
+        } | {
+            label: string;
+            value: string;
+            noValue: boolean;
+            selected?: undefined;
+            schema?: undefined;
+        })[];
+    };
+    schemaInitialize(schema: ISchema, { block }: {
+        block: string;
+    }): void;
+}