@nocobase/client-v2 2.1.0-alpha.4 → 2.1.0-alpha.45

package/es/ai/tools-manager/hooks/index.d.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 declare const useTools: () => import("./context").ToolsContextValue;
+export * from './context';
+export * from './provider';

package/es/ai/tools-manager/hooks/provider.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 } from 'react';
+import { ToolsManager } from '../types';
+interface ToolsProviderProps {
+    toolsManager: ToolsManager;
+    children: ReactNode;
+}
+export declare const ToolsProvider: React.FC<ToolsProviderProps>;
+export {};

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,56 @@
+/**
+ * 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;
+};
+export declare function getV2EffectiveBasePath(app: AppLike): string;
+declare function getDefaultV2AdminRedirectPath(app: AppLike): string;
+/**
+ * 将当前 v2 页面地址转换为根相对 redirect 路径。
+ *
+ * @param app 当前 v2 应用实例
+ * @param locationLike 当前路由地址
+ * @returns 根相对的 v2 redirect
+ */
+export declare function getCurrentV2RedirectPath(app: AppLike, locationLike: LocationLike): string;
+/**
+ * 构造跳转到 v2 登录页的完整 href。
+ *
+ * @param app 当前 v2 应用实例
+ * @param targetPath 登录后回跳地址
+ * @returns 指向 v2 登录页的 href
+ */
+export declare function buildV2SigninHref(app: AppLike, targetPath: string): string;
+/**
+ * 通过整页跳转进入 v2 登录页。
+ *
+ * @param app 当前 v2 应用实例
+ * @param targetPath 登录后回跳地址
+ * @param options 跳转选项
+ */
+export declare function redirectToV2Signin(app: AppLike, targetPath: string, options?: {
+    replace?: boolean;
+}): void;
+/**
+ * 解析并校验服务端返回的 v2 登录页地址。
+ *
+ * @param value 服务端返回的 redirect
+ * @param app 当前 v2 应用实例
+ * @returns 合法时返回完整同源 URL,否则返回 null
+ */
+export declare function resolveV2SigninRedirect(value: string | undefined | null, app: AppLike): string;
+export { getDefaultV2AdminRedirectPath };

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

@@ -0,0 +1,107 @@
+/**
+ * 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 type { ComponentType, ReactNode } from 'react';
+import { type FieldFilterable, type FieldFilterOperator } from '../collection-manager/filter-operators';
+import type { FieldConfigureItem } from '../collection-manager/field-configure';
+import { CollectionFieldInterfaceManager } from './CollectionFieldInterfaceManager';
+export type CollectionFieldInterfaceFactory = new (collectionFieldInterfaceManager: CollectionFieldInterfaceManager) => CollectionFieldInterface;
+export interface CollectionFieldInterfaceComponentOption {
+    label: string;
+    value: string;
+    useVisible?: () => boolean;
+    useProps?: () => any;
+}
+export type FieldConfigureFormMode = 'create' | 'edit';
+export interface FieldConfigureContext {
+    mode: FieldConfigureFormMode;
+    fieldInterface: CollectionFieldInterface | FieldInterfaceConfigure;
+    collection?: Record<string, any>;
+    field?: Record<string, any>;
+    disabledJSONB?: boolean;
+    createOnly?: boolean;
+    editMainOnly?: boolean;
+}
+export type FieldConfigureFormProps = FieldConfigureContext;
+export interface FieldConfigurePropertyComponentProps extends FieldConfigureContext {
+    name: string;
+    namePath: Array<string | number>;
+    schema: Record<string, any>;
+    form?: any;
+    disabled?: boolean;
+    collections?: Array<Record<string, any>>;
+    context: Record<string, boolean>;
+    title?: ReactNode;
+    tooltip?: ReactNode;
+    componentProps?: Record<string, any>;
+}
+export interface FieldInterfaceConfigure {
+    name?: string;
+    title?: ReactNode;
+    group?: string;
+    order?: number;
+    default?: Record<string, any>;
+    titleUsable?: boolean;
+    isAssociation?: boolean;
+    supportDataSourceType?: string[];
+    notSupportDataSourceType?: string[];
+    properties?: Record<string, any>;
+    items?: FieldConfigureItem[];
+    getConfigureFormProperties?: (collectionInfo?: Record<string, any>) => Record<string, any>;
+    components?: Record<string, ComponentType<FieldConfigurePropertyComponentProps>>;
+    initialize?: (values: Record<string, any>, context?: FieldConfigureContext) => void;
+    ConfigureForm?: ComponentType<FieldConfigureFormProps>;
+    Component?: ComponentType<FieldConfigureFormProps>;
+    normalizeValues?: (values: Record<string, any>, context: FieldConfigureContext) => Record<string, any>;
+    normalize?: (values: Record<string, any>, context: FieldConfigureContext) => Record<string, any>;
+    validate?: (values: Record<string, any>, context: FieldConfigureContext) => Promise<void> | void;
+}
+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?: FieldFilterOperator[];
+    properties?: any;
+    validationType?: string;
+    availableValidationOptions: string[];
+    configure?: FieldInterfaceConfigure;
+    excludeValidationOptions?: string[];
+    /**
+     * - 如果该值为空，则在 Filter 组件中该字段会被过滤掉
+     * - 如果该值为空，则不会在变量列表中看到该字段
+     */
+    filterable?: FieldFilterable;
+    titleUsable?: boolean;
+    usePathOptions?(field: any): any;
+    hidden?: boolean;
+    addComponentOption(componentOption: CollectionFieldInterfaceComponentOption): void;
+    getConfigureFormProperties(collectionInfo?: any): Record<string, ISchema>;
+    getDefaultValueProperty(): {
+        defaultValue: any;
+    };
+    addOperator(operatorOption: FieldFilterOperator): void;
+}

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

@@ -0,0 +1,188 @@
+/**
+ * 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 FieldFilterable, type FieldFilterOperator, type FieldFilterOperatorReference } from '../collection-manager/filter-operators';
+import { type FieldValidationConfigureInput, type FieldValidationConfigureItem } from '../collection-manager/field-validation';
+import type { FieldInterfaceConfigure } from './CollectionFieldInterface';
+import type { ReactNode } from 'react';
+interface FieldInterfaceLike {
+    name?: string;
+    title?: ReactNode;
+    group?: string;
+    order?: number;
+    isAssociation?: boolean;
+    supportDataSourceType?: string[];
+    notSupportDataSourceType?: string[];
+    properties?: Record<string, any>;
+    configure?: FieldInterfaceConfigure;
+    filterable?: FieldFilterable;
+    addComponentOption?: (option: any) => void;
+    addOperator?: (option: FieldFilterOperator) => void;
+    getConfigureFormProperties?: (collectionInfo?: any) => Record<string, any>;
+}
+interface PendingAction {
+    type: 'addComponentOption' | 'addOperator' | 'registerConfigure';
+    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: FieldFilterOperator): void;
+    /**
+     * 注册 v2 字段过滤操作符。
+     *
+     * 插件可通过该方法补充自己的过滤操作符，再把它们加入自定义 operator group。
+     *
+     * @param operator 过滤操作符配置
+     * @returns void
+     */
+    registerFieldFilterOperator(operator: FieldFilterOperator): void;
+    /**
+     * 注册 v2 字段过滤操作符分组。
+     *
+     * 字段 interface 可以通过 `createFilterable(groupName)` 引用这里注册的分组。
+     *
+     * @param name 分组名
+     * @param operators 操作符配置或已注册操作符名
+     * @returns void
+     */
+    registerFieldFilterOperatorGroup(name: string, operators?: FieldFilterOperatorReference[]): void;
+    /**
+     * 向已有 v2 字段过滤操作符分组追加操作符。
+     *
+     * @param name 分组名
+     * @param operators 操作符配置或已注册操作符名
+     * @returns void
+     */
+    addFieldFilterOperatorsToGroup(name: string, operators?: FieldFilterOperatorReference[]): void;
+    registerFieldValidationConfigure(item: FieldValidationConfigureItem): void;
+    registerFieldValidationConfigureGroup(name: string, items?: FieldValidationConfigureInput[]): void;
+    addFieldValidationConfiguresToGroup(name: string, items?: FieldValidationConfigureInput[]): void;
+    getFieldValidationConfigureGroup(name: string): FieldValidationConfigureItem[];
+    /**
+     * 注册字段接口创建/编辑字段时的配置项。
+     *
+     * 字段插件可以把复杂配置组件、配置属性、normalize / initialize 等逻辑挂到字段接口自身。
+     * 如果字段接口尚未注册，配置会暂存并在接口注册后回放。
+     *
+     * @param options 字段接口配置
+     * @returns void
+     */
+    registerFieldInterfaceConfigure(options: FieldInterfaceConfigure & {
+        name: string;
+    }): void;
+    /**
+     * 获取单个字段接口实例。
+     *
+     * @param name 字段接口名
+     * @returns 字段接口实例
+     */
+    getFieldInterface<T = FieldInterfaceLike>(name: string): T;
+    /**
+     * 获取全部字段接口实例。
+     *
+     * @param dataSourceType 可选的数据源类型过滤
+     * @returns 字段接口实例列表
+     */
+    getFieldInterfaces<T = FieldInterfaceLike>(dataSourceType?: string): T[];
+    /**
+     * 获取字段接口创建/编辑字段时的配置属性。
+     *
+     * 字段接口可以通过自身的 properties / getConfigureFormProperties() 定义专属配置项。
+     * 数据源管理等 v2 页面只需要通过该方法读取，不需要硬编码具体字段类型。
+     *
+     * @param name 字段接口名
+     * @param collectionInfo 当前数据表信息
+     * @returns 配置属性映射
+     */
+    getFieldInterfaceConfigureProperties(name: string, collectionInfo?: any): Record<string, any>;
+    /**
+     * 获取字段接口配置。
+     *
+     * 返回值会合并字段接口自身声明和后注册配置；后注册配置优先。
+     *
+     * @param name 字段接口名
+     * @param collectionInfo 当前数据表信息
+     * @returns 字段接口配置
+     */
+    getFieldInterfaceConfigure(name: string, collectionInfo?: any): FieldInterfaceConfigure;
+    /**
+     * 注册字段接口分组。
+     *
+     * @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;
+    protected normalizeFieldInterfaceFilterables(): void;
+    protected mergeFieldInterfaceConfigure(base?: FieldInterfaceConfigure, override?: FieldInterfaceConfigure): FieldInterfaceConfigure | undefined;
+    protected mergeFieldConfigureItems(baseItems?: FieldInterfaceConfigure['items'], overrideItems?: FieldInterfaceConfigure['items']): import("../collection-manager/field-configure").FieldConfigureItem[];
+}
+export {};

package/es/collection-manager/field-configure.d.ts

@@ -0,0 +1,80 @@
+/**
+ * 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, ReactNode } from 'react';
+export type FieldConfigureComponentType = 'Input' | 'Input.TextArea' | 'InputNumber' | 'Checkbox' | 'Checkbox.Group' | 'ColorPicker' | 'DatePicker' | 'Radio.Group' | 'Select' | 'CollectionSelect' | 'RemoteSelect' | 'TargetKey' | 'SourceKey' | 'ExpiresRadio' | 'ArrayTable' | 'FieldValidation' | 'ForeignKey' | 'Input.JSON' | 'Markdown' | 'Percent' | 'RichText' | 'SourceCollection' | 'Space' | 'ThroughCollection' | 'TimePicker' | 'UnixTimestamp' | (string & {});
+export declare const CollectionSelect = "CollectionSelect";
+export interface FieldConfigureRuntimeContext {
+    createOnly?: boolean;
+    editMainOnly?: boolean;
+    createMainOnly?: boolean;
+    disabledJSONB?: boolean;
+    primaryKeyOnly?: boolean;
+    showReverseFieldConfig?: boolean;
+    [key: string]: unknown;
+}
+export interface FieldConfigureRuntimeState {
+    componentProps?: Record<string, unknown>;
+    dataSource?: unknown;
+    disabled?: boolean;
+    hidden?: boolean;
+    hasValue?: boolean;
+    value?: unknown;
+}
+export interface FieldConfigureEffectContext {
+    changedName?: string;
+    context: FieldConfigureRuntimeContext;
+    getValue: (name: string) => unknown;
+    setValue: (name: string, value: unknown) => void;
+    values: Record<string, unknown>;
+}
+export interface FieldConfigureItem {
+    name: string;
+    title?: ReactNode;
+    component?: FieldConfigureComponentType;
+    Component?: ComponentType<any>;
+    componentProps?: Record<string, unknown>;
+    defaultValue?: unknown;
+    description?: ReactNode;
+    hidden?: boolean | string | ((context: FieldConfigureEffectContext) => boolean);
+    disabled?: boolean | string | ((context: FieldConfigureEffectContext) => boolean);
+    options?: Array<{
+        label: ReactNode;
+        value: string | number | boolean;
+    }>;
+    required?: boolean;
+    dependencies?: string[];
+    effect?: (context: FieldConfigureEffectContext) => void;
+    schema?: Record<string, unknown>;
+    layout?: {
+        row?: string;
+        column?: string;
+        columnIndex?: number;
+        span?: number;
+    };
+}
+export declare function evaluateFieldConfigureExpression(value: unknown, context: FieldConfigureEffectContext): boolean;
+export declare function configurePropertiesToItems(properties?: Record<string, any>, options?: {
+    components?: Record<string, ComponentType<any>>;
+}): FieldConfigureItem[];
+export declare function getCoreFieldConfigureState(name: string, values: Record<string, unknown>, context?: FieldConfigureRuntimeContext): FieldConfigureRuntimeState;
+export declare function runCoreFieldConfigureEffects(options: FieldConfigureEffectContext): void;
+export declare function indexConfigureItems(options?: {
+    autoIncrement?: boolean;
+}): FieldConfigureItem[];
+export declare function dateTimeFormatConfigureItems(options?: {
+    includePicker?: boolean;
+    hidden?: FieldConfigureItem['hidden'];
+    showTimeDefault?: boolean;
+}): FieldConfigureItem[];
+export declare function reverseFieldConfigureItems(): FieldConfigureItem[];
+export declare const reverseFieldConfigureItem: typeof reverseFieldConfigureItems;
+export declare function OptionsEditor(options?: {
+    name?: string;
+    title?: ReactNode;
+}): FieldConfigureItem;

package/es/collection-manager/field-validation.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 { ReactNode } from 'react';
+export interface FieldValidationConfigureParam {
+    key: string;
+    label: ReactNode;
+    componentType?: 'checkbox' | 'datePicker' | 'inputNumber' | 'multipleSelect' | 'radio' | 'singleSelect' | 'text';
+    defaultValue?: unknown;
+    options?: Array<{
+        label: ReactNode;
+        value: string | number | boolean;
+    }>;
+    required?: boolean;
+}
+export interface FieldValidationConfigureItem {
+    key: string;
+    label: ReactNode;
+    hasValue?: boolean;
+    params?: FieldValidationConfigureParam[];
+    paramsType?: string;
+}
+export type FieldValidationConfigureInput = FieldValidationConfigureItem | string;
+export declare function RangeValidationItems(valueKind: 'date' | 'number'): FieldValidationConfigureItem[];
+export declare class FieldValidationConfigureRegistry {
+    protected items: Map<string, FieldValidationConfigureItem>;
+    protected groups: Map<string, FieldValidationConfigureInput[]>;
+    register(item: FieldValidationConfigureItem): void;
+    registerMany(items?: FieldValidationConfigureItem[]): void;
+    registerGroup(name: string, items?: FieldValidationConfigureInput[]): void;
+    addToGroup(name: string, items?: FieldValidationConfigureInput[]): void;
+    get(name: string): FieldValidationConfigureItem;
+    getGroup(name: string): FieldValidationConfigureItem[];
+}
+export declare const fieldValidationConfigureRegistry: FieldValidationConfigureRegistry;
+export declare function registerFieldValidationConfigure(item: FieldValidationConfigureItem): void;
+export declare function registerFieldValidationConfigureGroup(name: string, items?: FieldValidationConfigureInput[]): void;
+export declare function addFieldValidationConfiguresToGroup(name: string, items?: FieldValidationConfigureInput[]): void;

package/es/collection-manager/filter-operators/index.d.ts

@@ -0,0 +1,46 @@
+/**
+ * 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 * as standardFieldFilterOperatorGroups from './operators';
+import type { FieldFilterOperator } from './operators';
+export * from './operators';
+export type FieldFilterOperatorPreset = keyof typeof standardFieldFilterOperatorGroups;
+export type FieldFilterOperatorGroupName = FieldFilterOperatorPreset | (string & {});
+export type FieldFilterOperatorReference<TMeta = unknown> = FieldFilterOperator<TMeta> | string;
+export type FieldFilterOperatorList<TMeta = unknown> = FieldFilterOperator<TMeta>[] | FieldFilterOperatorGroupName;
+export type FieldFilterable<TMeta = unknown> = {
+    operators?: FieldFilterOperatorList<TMeta>;
+    operatorGroup?: string;
+    children?: unknown[];
+    nested?: boolean;
+    [key: string]: unknown;
+};
+export declare class FieldFilterOperatorRegistry {
+    protected operators: Record<string, FieldFilterOperator>;
+    protected groups: Record<string, FieldFilterOperator[]>;
+    constructor(groups?: Record<string, FieldFilterOperator[]>);
+    register(operator: FieldFilterOperator): this;
+    registerMany(operators?: FieldFilterOperator[]): this;
+    registerGroup(name: string, operators?: FieldFilterOperatorReference[]): this;
+    addToGroup(name: string, operators?: FieldFilterOperatorReference[]): this;
+    get(name: string): standardFieldFilterOperatorGroups.FieldFilterOperator;
+    getGroup(name: string): standardFieldFilterOperatorGroups.FieldFilterOperator[];
+    getGroups(): Record<string, standardFieldFilterOperatorGroups.FieldFilterOperator[]>;
+    resolveOperators<TMeta = unknown>(operators?: FieldFilterOperatorList<TMeta>): FieldFilterOperator<TMeta>[];
+    protected resolveOperatorReferences(operators?: FieldFilterOperatorReference[]): standardFieldFilterOperatorGroups.FieldFilterOperator[];
+}
+export declare const filterOperatorRegistry: FieldFilterOperatorRegistry;
+export declare const fieldFilterOperators: Record<string, standardFieldFilterOperatorGroups.FieldFilterOperator[]> & typeof standardFieldFilterOperatorGroups;
+export declare const fieldFilterOperatorPresets: Record<string, standardFieldFilterOperatorGroups.FieldFilterOperator[]> & typeof standardFieldFilterOperatorGroups;
+export declare function resolveFilterOperators<TMeta = unknown>(operators?: FieldFilterOperatorList<TMeta>): FieldFilterOperator<TMeta>[];
+export declare function normalizeFilterableOperators<TMeta = unknown>(filterable?: FieldFilterable<TMeta>): FieldFilterable<TMeta>;
+export declare function createFilterable<TPreset extends FieldFilterOperatorGroupName>(preset: TPreset, options?: Omit<FieldFilterable, 'operators'>): FieldFilterable;
+export declare function createTypedFilterable<TMeta = unknown>(groups: Array<{
+    types: string[];
+    operators: FieldFilterOperatorList<TMeta>;
+}>, resolveType: (meta: TMeta) => string): FieldFilterable<TMeta>;