@nocobase/client-v2 2.1.0-beta.37 → 2.1.0-beta.40

package/es/flow/admin-shell/admin-layout/AdminLayoutModel.d.ts

@@ -7,22 +7,18 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 import { type FlowEngine, FlowModel } from '@nocobase/flow-engine';
+import React from 'react';
 import type { NocoBaseDesktopRoute } from '../../../flow-compat';
-import { type RoutePageMeta } from '../AdminLayoutRouteCoordinator';
+import { AdminLayoutRouteCoordinator } from '../AdminLayoutRouteCoordinator';
+import { BaseLayoutModel, type BaseLayoutStructure, type GetLayoutModelOptions } from '../BaseLayoutModel';
 import { type AdminLayoutMenuItemModel } from './AdminLayoutMenuModels';
 import { type AdminLayoutMenuRouteOptions } from './AdminLayoutMenuUtils';
-import React from 'react';
-export type AdminLayoutStructure = {
+export type AdminLayoutStructure = BaseLayoutStructure & {
     subModels: {
         menuItems?: AdminLayoutMenuItemModel[];
     };
 };
-type GetAdminLayoutModelOptions<TModel extends FlowModel = AdminLayoutModel> = {
-    required?: boolean;
-    create?: boolean;
-    props?: any;
-    use?: new (...args: any[]) => TModel;
-};
+type GetAdminLayoutModelOptions<TModel extends FlowModel = AdminLayoutModel> = GetLayoutModelOptions<TModel>;
 /**
  * Admin Layout 的纯运行时 host model。
  *
@@ -35,14 +31,8 @@ type GetAdminLayoutModelOptions<TModel extends FlowModel = AdminLayoutModel> = {
  * model.syncMenuRoutes(routes);
  * ```
  */
-export declare class AdminLayoutModel extends FlowModel<AdminLayoutStructure> {
-    isMobileLayout: boolean;
+export declare class AdminLayoutModel extends BaseLayoutModel<AdminLayoutStructure> {
     menuRouteRefreshVersion: number;
-    private routeCoordinator?;
-    private routeDisposer?;
-    private activePageUid;
-    private layoutContentElement;
-    private readonly routePageMetaMap;
     constructor(options: any);
     /**
      * 通知 Layout 重新生成 ProLayout 菜单路由。
@@ -50,29 +40,6 @@ export declare class AdminLayoutModel extends FlowModel<AdminLayoutStructure> {
      * @returns {void}
      */
     refreshMenuRouteTree(): void;
-    /**
-     * 注册页面运行时信息。
-     *
-     * @param {string} pageUid 页面 UID
-     * @param {RoutePageMeta} meta 页面运行时元数据
-     * @returns {FlowModel} 对应的页面模型
-     */
-    registerRoutePage(pageUid: string, meta: RoutePageMeta): FlowModel<import("@nocobase/flow-engine").DefaultStructure>;
-    /**
-     * 更新页面运行时信息。
-     *
-     * @param {string} pageUid 页面 UID
-     * @param {Partial<RoutePageMeta>} meta 待更新的页面元数据
-     * @returns {void}
-     */
-    updateRoutePage(pageUid: string, meta: Partial<RoutePageMeta>): void;
-    /**
-     * 注销页面运行时信息。
-     *
-     * @param {string} pageUid 页面 UID
-     * @returns {void}
-     */
-    unregisterRoutePage(pageUid: string): void;
     /**
      * 使用当前可访问菜单路由刷新 Layout 菜单树。
      *
@@ -90,59 +57,7 @@ export declare class AdminLayoutModel extends FlowModel<AdminLayoutStructure> {
         path: string;
         children: import("./AdminLayoutMenuUtils").AdminLayoutMenuNode[];
     };
-    /**
-     * 设置布局内容容器元素。
-     *
-     * @param {HTMLElement | null} element 布局内容容器
-     * @returns {void}
-     */
-    setLayoutContentElement(element: HTMLElement | null): void;
-    /**
-     * 设置是否为移动端布局。
-     *
-     * @param {boolean} isMobileLayout 是否为移动端布局
-     * @returns {void}
-     */
-    setIsMobileLayout(isMobileLayout: boolean): void;
-    protected onMount(): void;
-    protected onUnmount(): void;
-    /**
-     * 安装运行时上下文属性。
-     *
-     * @returns {void}
-     */
-    private setupContextBindings;
-    /**
-     * 安装路由同步 reaction。
-     *
-     * @returns {void}
-     */
-    private setupRouteReaction;
-    /**
-     * 释放运行时状态。
-     *
-     * @returns {void}
-     */
-    private teardownRuntime;
-    /**
-     * 获取当前激活页面对应的路由对象。
-     *
-     * @returns {any} 当前激活页面对应的路由对象
-     */
-    private getCurrentRouteByActivePage;
-    /**
-     * 根据页面 UID 获取路由对象。
-     *
-     * @param {string} pageUid 页面 UID
-     * @returns {any} 路由对象
-     */
-    private getCurrentRouteByPageUid;
-    /**
-     * 懒加载页面路由协调器。
-     *
-     * @returns {AdminLayoutRouteCoordinator} 路由协调器实例
-     */
-    private getCoordinator;
+    protected createRouteCoordinator(): AdminLayoutRouteCoordinator;
     render(): React.JSX.Element;
 }
 /**

package/es/flow/admin-shell/admin-layout/index.d.ts

@@ -8,6 +8,8 @@
  */
 export * from './AdminLayoutComponent';
 export * from './AdminLayoutModel';
+export * from '../BaseLayoutModel';
+export * from '../BaseLayoutRouteCoordinator';
 export * from './AdminLayoutSlotModels';
 export * from './AdminLayoutMenuModels';
 export * from './AdminLayoutMenuFlowUtils';

package/es/flow/admin-shell/useAdminLayoutRoutePage.d.ts

@@ -6,14 +6,14 @@
  * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
-/// <reference types="react" />
 import type { FlowEngine } from '@nocobase/flow-engine';
+import type { RefObject } from 'react';
 import { type AdminLayoutModel } from './admin-layout/AdminLayoutModel';
 type UseAdminLayoutRoutePageOptions = {
     flowEngine: FlowEngine;
     pageUid: string;
     refreshDesktopRoutes?: () => Promise<unknown>;
-    layoutContentRef: React.RefObject<HTMLDivElement>;
+    layoutContentRef: RefObject<HTMLDivElement>;
 };
 /**
  * 把 FlowRoute 页面的生命周期桥接到 AdminLayout host model。

package/es/flow/admin-shell/useLayoutRoutePage.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 { FlowEngine } from '@nocobase/flow-engine';
+import { type RefObject } from 'react';
+import type { BaseLayoutModel } from './BaseLayoutModel';
+export type UseLayoutRoutePageOptions<TModel extends BaseLayoutModel = BaseLayoutModel> = {
+    flowEngine: FlowEngine;
+    pageUid: string;
+    active?: boolean;
+    refreshDesktopRoutes?: () => Promise<unknown>;
+    layoutContentRef: RefObject<HTMLElement>;
+    getLayoutModel: (flowEngine: FlowEngine) => TModel | undefined;
+};
+/**
+ * 把 FlowRoute 页面的生命周期桥接到指定 Layout host model。
+ */
+export declare function useLayoutRoutePage<TModel extends BaseLayoutModel = BaseLayoutModel>(options: UseLayoutRoutePageOptions<TModel>): TModel;

package/es/flow/components/FlowRoute.d.ts

@@ -6,7 +6,16 @@
  * 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 FlowEngine } from '@nocobase/flow-engine';
 import React from 'react';
+import { type BaseLayoutModel } from '../admin-shell/BaseLayoutModel';
+export type LegacyPageBehavior = 'redirect' | 'notFound' | 'bridge';
+export type FlowRouteProps = {
+    pageUid?: string;
+    active?: boolean;
+    getLayoutModel?: (flowEngine: FlowEngine) => BaseLayoutModel | undefined;
+    legacyPageBehavior?: LegacyPageBehavior;
+};
 /**
  * 管理后台动态页面路由组件。
  *
@@ -22,7 +31,7 @@ import React from 'react';
  * @throws {Error} 当缺少 `route.params.name` 时抛出异常
  */
 declare const FlowRoute: {
-    (): React.JSX.Element;
+    (props?: FlowRouteProps): React.JSX.Element;
     displayName: string;
 };
 export default FlowRoute;

package/es/flow/components/filter/useFilterOptions.d.ts

@@ -36,10 +36,22 @@ export type FilterOption = {
 };
 export interface UseFilterOptionsArgs {
     /**
+     * **Preferred way to restrict fields**, alongside `nonfilterableFieldNames`.
+     *
      * Whitelist of root-level field names to expose. Empty/undefined means "all filterable fields". The whitelist applies only at depth 1 — nested fields under an allowed association field are always included, matching the legacy v1 `Filter.Action` behaviour.
      */
     filterableFieldNames?: string[];
-    /** Bypass the `filterableFieldNames` whitelist (mirrors v1 `noIgnore`). */
+    /**
+     * **Preferred way to restrict fields**, alongside `filterableFieldNames`.
+     *
+     * Blacklist of root-level field names to drop. Mirrors v1's `nonfilterable: [...]` schema prop on `Filter.Action`. Applies at depth 1 only, same as the whitelist. When both `filterableFieldNames` and `nonfilterableFieldNames` are provided, both apply: the final field set is `(whitelist or all) minus blacklist`.
+     */
+    nonfilterableFieldNames?: string[];
+    /**
+     * Bypass the `filterableFieldNames` whitelist (mirrors v1 `noIgnore`).
+     *
+     * Legacy escape hatch from v1 schemas — prefer adjusting `filterableFieldNames` / `nonfilterableFieldNames` instead. Kept only for parity with existing v1 schemas that already set `noIgnore`.
+     */
     noIgnore?: boolean;
     /** Translator used for field/operator labels. Defaults to identity. */
     t?: (key: string) => string;

package/es/flow/index.d.ts

@@ -23,7 +23,11 @@ export * from './utils';
 export * from './actions';
 export * from './system-settings';
 export * from './admin-shell/admin-layout';
+export * from './admin-shell/BaseLayoutModel';
+export * from './admin-shell/BaseLayoutRouteCoordinator';
 export * from './admin-shell/AdminLayoutRouteCoordinator';
+export * from './admin-shell/useLayoutRoutePage';
+export * from './admin-shell/useAdminLayoutRoutePage';
 export * from '../settings-center';
 export { openViewFlow } from './flows/openViewFlow';
 export { editMarkdownFlow } from './flows/editMarkdownFlow';

package/es/flow/models/base/PageModel/PageModel.d.ts

@@ -32,9 +32,11 @@ export declare class PageModel extends FlowModel<PageModelStructure> {
     private getEnableTabs;
     private getActiveTabKey;
     private scheduleActiveLifecycleRefresh;
+    activateCurrentTab(forceRefresh?: boolean): void;
+    deactivateCurrentTab(): void;
     onMount(): void;
     protected onUnmount(): void;
-    invokeTabModelLifecycleMethod(tabActiveKey: string, method: 'onActive' | 'onInactive', forceRefresh?: boolean): void;
+    invokeTabModelLifecycleMethod(tabActiveKey: string | undefined, method: 'onActive' | 'onInactive', forceRefresh?: boolean): void;
     /**
      * Resolve configured document title template and update browser tab title.
      * Priority:

package/es/flow/models/blocks/assign-form/assignFieldValuesFlow.d.ts

@@ -0,0 +1,84 @@
+/**
+ * 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 FlowModelContext } from '@nocobase/flow-engine';
+import React from 'react';
+import { AssignFormModel } from './AssignFormModel';
+export declare const ASSIGN_FIELD_VALUES_STEP_KEY = "assignFieldValues";
+type AssignedValues = Record<string, unknown>;
+type AssignFieldValuesCollection = {
+    dataSourceKey?: string;
+    name?: string;
+};
+type AssignFieldValuesContext = FlowModelContext & {
+    collection?: AssignFieldValuesCollection;
+    flowSettingsEnabled?: boolean;
+};
+type AssignFieldValuesModel = {
+    uid: string;
+    assignFormUid?: string;
+    context?: AssignFieldValuesContext;
+    getStepParams?: (flowKey: string, stepKey: string) => {
+        assignedValues?: AssignedValues;
+    } | undefined;
+    setStepParams?: (flowKey: string, stepKey: string, params: {
+        assignedValues: AssignedValues;
+    }) => void;
+};
+type AssignFieldValuesStepOptions = {
+    settingsFlowKey: string;
+    title?: string;
+    tipComponent?: React.ComponentType;
+    validateBeforeSave?: boolean;
+    clearRecordContext?: boolean;
+};
+export declare function createAssignFormSubModelOptions(ctx: AssignFieldValuesContext): {
+    async: boolean;
+    use: string;
+    stepParams: {
+        resourceSettings: {
+            init: {
+                dataSourceKey: string;
+                collectionName: string;
+            };
+        };
+    };
+};
+export declare function getAssignFieldValuesDefaultParams(ctx: {
+    model: Pick<AssignFieldValuesModel, 'getStepParams'>;
+}, settingsFlowKey: string): {
+    assignedValues: AssignedValues;
+};
+export declare function resolveAssignFieldValues(ctx: {
+    message?: {
+        error?: (message: string) => void;
+    };
+    t?: (message: string) => string;
+}, rawAssignedValues: unknown, logName?: string): Promise<AssignedValues | null>;
+export declare function mergeAssignFieldValues<T extends Record<string, unknown>>(values: T, assignedValues?: AssignedValues | null): T;
+export declare function createAssignFieldValuesStep(options: AssignFieldValuesStepOptions): {
+    title: string;
+    uiSchema(): {
+        tip: {
+            'x-decorator': string;
+            'x-component': React.ComponentType<{}>;
+        };
+        editor: {
+            'x-decorator': string;
+            'x-component': () => React.JSX.Element;
+        };
+    };
+    beforeParamsSave(ctx: {
+        model: AssignFieldValuesModel;
+        engine: {
+            getModel?: (uid: string, fromRoot?: boolean) => AssignFormModel | undefined;
+        };
+    }): Promise<void>;
+    handler(): void;
+};
+export {};

package/es/flow/models/blocks/assign-form/index.d.ts

@@ -9,3 +9,4 @@
 export * from './AssignFormModel';
 export * from './AssignFormGridModel';
 export * from './AssignFormItemModel';
+export * from './assignFieldValuesFlow';

package/es/flow/models/blocks/form/FormActionGroupModel.d.ts

@@ -10,4 +10,5 @@ import { ActionGroupModel } from '../../base/ActionGroupModel';
 import { FormActionModel } from './FormActionModel';
 export declare class FormActionGroupModel extends ActionGroupModel {
     static baseClass: typeof FormActionModel;
+    static defineChildren(ctx: any): Promise<any[]>;
 }

package/es/flow/models/blocks/form/FormActionModel.d.ts

@@ -6,12 +6,19 @@
  * 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 { DefaultStructure } from '@nocobase/flow-engine';
 import { ButtonProps } from 'antd';
 import { AxiosRequestConfig } from 'axios';
 import { ActionModel } from '../../base/ActionModelCore';
-export declare class FormActionModel extends ActionModel {
+import { AssignFormModel } from '../assign-form/AssignFormModel';
+export declare class FormActionModel<T extends DefaultStructure = DefaultStructure> extends ActionModel<T> {
 }
-export declare class FormSubmitActionModel extends FormActionModel {
+export declare class FormSubmitActionModel extends FormActionModel<{
+    subModels: {
+        assignForm: AssignFormModel;
+    };
+}> {
+    assignFormUid?: string;
     defaultProps: ButtonProps;
     /**
      * 简化设置保存请求配置的方式

package/es/flow/models/blocks/table/TableBlockModel.d.ts

@@ -61,8 +61,18 @@ export declare class TableBlockModel extends CollectionBlockModel<TableBlockMode
             cell: React.MemoExoticComponent<import("@formily/reactive-react").ReactFC<Omit<any, "ref">>>;
         };
     };
+    isRowSelectionEnabled(): boolean;
+    isShowIndexEnabled(): boolean;
+    getRecordIndex(record: Record<string, unknown>, index: number): string | number;
+    getLeftAuxiliaryColumn(): {
+        key: string;
+        width: number;
+        align: "center";
+        render: (_value: unknown, record: Record<string, unknown>, index: number) => React.JSX.Element;
+    };
     renderCell: (checked: any, record: any, index: any, originNode: any) => any;
     renderConfigureActions(): React.JSX.Element;
+    shouldRenderAction(action: ActionModel, isConfigMode: boolean): boolean;
     pagination(): import("antd").PaginationProps;
     renderComponent(): React.JSX.Element;
 }

package/es/flow/models/fields/AssociationFieldModel/SubTableFieldModel/index.d.ts

@@ -8,7 +8,7 @@ export declare class SubTableFieldModel extends AssociationFieldModel {
     updateAssociation: boolean;
     setCurrentPage: any;
     currentPageSize: any;
-    getCurrentValue: () => any[];
+    getCurrentValue(): any[];
     get collection(): any;
     getColumns(): any;
     render(): React.JSX.Element;

package/es/index.d.ts

@@ -24,12 +24,17 @@ export * from './WebSocketClient';
 export * from './RouterManager';
 export * from './PluginManager';
 export * from './PluginSettingsManager';
+export * from './layout-manager';
 export * from './hooks';
 export { default as languageCodes } from './locale/languageCodes';
 export * from './nocobase-buildin-plugin';
 export * from './collection-field-interface/CollectionFieldInterface';
 export * from './collection-field-interface/CollectionFieldInterfaceManager';
+export * from './collection-manager/field-configure';
+export * from './collection-manager/field-validation';
+export * from './collection-manager/filter-operators';
 export * from './collection-manager/interfaces';
+export * from './collection-manager/template-fields';
 export * from './data-source';
 export * from './flow';
 export { DEFAULT_DATA_SOURCE_KEY, isTitleField, isTitleFieldInterface } from './flow-compat';