@nocobase/client-v2 2.1.0-beta.36 → 2.1.0-beta.38

package/es/Application.d.ts

@@ -28,6 +28,7 @@ export interface ApplicationOptions extends BaseApplicationOptions<PluginType> {
 }
 export declare class Application extends BaseApplication<ApplicationOptions, PluginManager, RouterManager, APIClient, PluginSettingsManager> {
     dataSourceManager: any;
+    hasLoadError: boolean;
     protected createApiClient(options: ApplicationOptions): APIClient;
     protected configureRuntimeAdapters(): void;
     protected createI18n(options: ApplicationOptions): i18next;

package/es/BaseApplication.d.ts

@@ -12,6 +12,7 @@ import type { i18n as i18next } from 'i18next';
 import React, { ReactElement, ReactNode } from 'react';
 import { AIManager } from './ai';
 import { SystemSettingsSource } from './flow/system-settings';
+import { LayoutManager } from './layout-manager/LayoutManager';
 import type { PluginClass, PluginManager, PluginType } from './PluginManager';
 import { RouteRepository } from './RouteRepository';
 import type { ComponentTypeAndString, RenderableComponentType, RouterComponentType, RouterManager, RouterOptions } from './RouterManager';
@@ -71,6 +72,7 @@ export declare abstract class BaseApplication<TOptions extends BaseApplicationOp
     components: Record<string, AnyComponent>;
     pluginManager: TPluginManager;
     pluginSettingsManager: TPluginSettingsManager;
+    layoutManager: LayoutManager<this>;
     aiManager: AIManager;
     devDynamicImport?: DevDynamicImport;
     requirejs: RequireJS;
@@ -106,6 +108,7 @@ export declare abstract class BaseApplication<TOptions extends BaseApplicationOp
     get pm(): TPluginManager;
     get disableAcl(): boolean;
     get isWsAuthorized(): boolean;
+    setDocumentLanguage(language?: string | null): void;
     constructor(options?: TOptions);
     /**
      * 注册共享 observable 状态。
@@ -160,6 +163,7 @@ export declare abstract class BaseApplication<TOptions extends BaseApplicationOp
     protected abstract createRouterManager(options: TOptions): TRouterManager;
     protected abstract createPluginManager(options: TOptions): TPluginManager;
     protected abstract createPluginSettingsManager(options: TOptions): TPluginSettingsManager;
+    protected createLayoutManager(_options: TOptions): LayoutManager<this>;
     protected createWebSocketClient(options: TOptions): WebSocketClient;
     protected getDefaultComponents(): Record<string, AnyComponent>;
     abstract load(): Promise<void>;

package/es/RouterManager.d.ts

@@ -34,6 +34,7 @@ export interface RouteType extends Omit<RouteObject, 'children' | 'Component'> {
     Component?: ComponentTypeAndString;
     componentLoader?: ComponentLoader;
     skipAuthCheck?: boolean;
+    authCheck?: boolean;
 }
 export type RenderComponentType = (Component: ComponentTypeAndString, props?: any) => React.ReactNode;
 export type RouterComponentType = React.FC<{

package/es/components/KeepAlive.d.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 React, { FC } from 'react';
+export declare const KeepAliveProvider: FC<{
+    active: boolean;
+    parentActive: boolean;
+}>;
+export declare const useKeepAlive: () => {
+    active: boolean;
+};
+interface KeepAliveProps {
+    uid: string;
+    children: (uid: string) => React.ReactNode;
+}
+export declare const KeepAlive: FC<KeepAliveProps>;
+export {};

package/es/components/RouterBridge.d.ts

@@ -7,7 +7,16 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 import { Application } from '../Application';
+type LayoutMatchLike = {
+    id: string;
+    pathname: string;
+};
+type LayoutDefinitionLike = {
+    routeName: string;
+};
+export declare function findDeepestLayoutMatch(layouts?: LayoutDefinitionLike[], matches?: LayoutMatchLike[]): LayoutMatchLike;
 export declare function useRouterSync(app: Application): void;
 export declare function RouterBridge({ app }: {
     app: any;
 }): any;
+export {};

package/es/components/form/DialogFormLayout.d.ts

@@ -12,17 +12,9 @@ export interface DialogFormLayoutProps {
     title: React.ReactNode;
     /** Form body — typically a `<Form>` wrapping `<Form.Item>` fields. */
     children: React.ReactNode;
-    /**
-     * Called before the dialog is closed by the Cancel button or the
-     * top-right close (X) icon. Use for "discard changes" confirmations.
-     */
+    /** Called before the dialog is closed by the Cancel button or the top-right close (X) icon. Use for "discard changes" confirmations. */
     onCancel?: () => void | Promise<void>;
-    /**
-     * Called when the Submit button is clicked. Caller owns validation
-     * + the actual API call; the dialog is closed automatically when
-     * `onSubmit` resolves. Throw from `onSubmit` to keep the dialog open
-     * (e.g. on a validation error).
-     */
+    /** Called when the Submit button is clicked. Caller owns validation + the actual API call; the dialog is closed automatically when `onSubmit` resolves. Throw from `onSubmit` to keep the dialog open (e.g. on a validation error). */
     onSubmit?: () => void | Promise<void>;
     /** Drives the Submit button's loading state. */
     submitting?: boolean;
@@ -30,29 +22,13 @@ export interface DialogFormLayoutProps {
     submitText?: React.ReactNode;
     /** Override the Cancel button label. Defaults to "Cancel". */
     cancelText?: React.ReactNode;
-    /**
-     * Full override of the footer content. When provided, the default
-     * Cancel + Submit buttons are replaced. Useful for forms that need
-     * extra actions (e.g. Preview, Save draft).
-     */
+    /** Full override of the footer content. When provided, the default Cancel + Submit buttons are replaced. Useful for forms that need extra actions (e.g. Preview, Save draft). */
     footer?: React.ReactNode;
 }
 /**
- * Standard layout for dialog-hosted forms — the dialog counterpart of
- * `DrawerFormLayout`. Title sits left-aligned in the dialog's native
- * header (no inline close icon — the dialog provides its own X in the
- * top-right when opened with `viewer.dialog({ closable: true, ... })`),
- * the form body fills the middle, and a Cancel + Submit footer sits
- * at the bottom.
+ * Standard layout for dialog-hosted forms — the dialog counterpart of `DrawerFormLayout`. Title sits left-aligned in the dialog's native header, the form body fills the middle, and a Cancel + Submit footer sits at the bottom. Neither this layout nor `DrawerFormLayout` renders a close icon — both rely on the caller passing `closable: true` at the `viewer.dialog` / `viewer.drawer` call site to surface antd Modal's native top-right X (Dialog) or antd Drawer's native left-side X (Drawer).
  *
- * Why not just reuse `DrawerFormLayout`? `DrawerFormLayout` injects a
- * `<CloseOutlined>` button next to the title — that's the drawer
- * visual contract (close lives near the title in a side panel). In a
- * centered dialog the native top-right close button is the expected
- * affordance, so a separate layout keeps the visual contract clean.
- *
- * Callers own the `<Form>` instance, validation, and the actual API
- * call. This component only handles the chrome and close behaviour.
+ * Callers own the `<Form>` instance, validation, and the actual API call. This component only handles the chrome and close behaviour.
  *
  * Example:
  *

package/es/components/form/filter/CollectionFilter.d.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 type { Collection } from '@nocobase/flow-engine';
+import { type ButtonProps, type PopoverProps } from 'antd';
+import React, { FC } from 'react';
+import { CompiledFilter } from './useFilterActionProps';
+export interface CollectionFilterProps {
+    /** Collection whose fields drive the filter row's field picker. */
+    collection: Collection | undefined;
+    /** Called on Submit or Reset with the compiled NocoBase filter param (`undefined` when cleared). */
+    onChange: (filter: CompiledFilter) => void;
+    /** Translator. Defaults to identity. */
+    t?: (key: string, options?: Record<string, any>) => string;
+    /** Whitelist of root-level field names to expose. */
+    filterableFieldNames?: string[];
+    /** Bypass the `filterableFieldNames` whitelist. */
+    noIgnore?: boolean;
+    /** Override the trigger button's label. Defaults to `t('Filter')`, or the v1-style `t('{{count}} filter items', { count })` when conditions are present. */
+    buttonText?: React.ReactNode;
+    /** Swap the default `t('Filter')` label for v1's `t('{{count}} filter items', { count })` when conditions are present. Defaults to `true`. */
+    showCount?: boolean;
+    /** Pass-through props for the antd `<Popover>`. */
+    popoverProps?: Omit<PopoverProps, 'open' | 'onOpenChange' | 'content' | 'children'>;
+    /** Pass-through props for the trigger `<Button>`. */
+    buttonProps?: Omit<ButtonProps, 'icon' | 'type' | 'children' | 'onClick'>;
+    /** Min-width applied to the popover body. Defaults to `520`. */
+    popoverMinWidth?: number;
+}
+/**
+ * Filter button bound to a collection. Renders an antd `<Popover>` over a `<Button>`; the popover hosts a multi-condition filter form (field picker, operator, value). Submit dismisses the popover and emits the compiled filter via `onChange`; Reset keeps the popover open and emits `undefined`.
+ *
+ * Pair with `<ExtendCollectionsProvider>` when the target collection is client-only (e.g. a `schema-only` server collection that isn't auto-published to the v2 data source).
+ */
+export declare const CollectionFilter: FC<CollectionFilterProps>;
+export default CollectionFilter;

package/es/components/form/filter/CollectionFilterItem.d.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 { Collection } from '@nocobase/flow-engine';
+import React, { FC } from 'react';
+export interface CollectionFilterItemValue {
+    path: string;
+    operator: string;
+    /** Operator-dependent — string for default ops, descriptor for $date*, etc. */
+    value: any;
+}
+export interface CollectionFilterItemProps {
+    /** Reactive filter row managed by the parent `FilterContainer`. */
+    value: CollectionFilterItemValue;
+    /** Target collection whose fields populate the field selector. */
+    collection: Collection;
+    /** Whitelist of field names to expose; empty/undefined means all filterable fields. */
+    filterableFieldNames?: string[];
+    /** Bypass the `filterableFieldNames` whitelist (matches the legacy FilterItem `noIgnore`). */
+    noIgnore?: boolean;
+    /** Translator; defaults to identity so callers can omit it. */
+    t?: (key: string) => string;
+}
+/**
+ * Filter row bound directly to a `Collection`, with no `FlowModel` dependency. Use this from settings pages or other surfaces that need a filter UI but don't have (and shouldn't synthesise) a block model just to satisfy `FilterItem`. Pair with `FilterContainer` via either an inline wrapper or `createCollectionFilterItem(collection)`.
+ *
+ * The field selector is an antd `Cascader`, mirroring v1's `Filter.Action` so association fields (belongsTo / m2o / etc.) can be drilled into — picking `user.username` is a first-class action. The value renderer is delegated to `FilterValueInput`, which dispatches to interface-specific controls (the smart date picker for `$date*` operators, tag-mode Select for array/enum, etc.) the same way v1's `DynamicComponent` did.
+ */
+export declare const CollectionFilterItem: FC<CollectionFilterItemProps>;
+/**
+ * Convenience factory returning a `FilterContainer`-compatible `FilterItem` component bound to a specific collection. Avoids creating an inline closure on every parent render, which would otherwise reset any focused inner antd control.
+ */
+export declare function createCollectionFilterItem(collection: Collection, bound?: Pick<CollectionFilterItemProps, 'filterableFieldNames' | 'noIgnore' | 't'>): React.FC<{
+    value: CollectionFilterItemValue;
+}>;
+export default CollectionFilterItem;

package/es/components/form/filter/DateFilterDynamicComponent.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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 Dayjs } from 'dayjs';
+import React from 'react';
+/**
+ * Value shape used by NocoBase's `$date*` filter operators. Two flavours:
+ *
+ * - For "Exact day" mode: a **formatted string** at the granularity of the picker — `"2026-02-15"` (date), `"2026-02"` (month), `"2026"` (year), `"2026-Q1"` (quarter). For `$dateBetween` (`isRange`), a `[string, string]` tuple. Strings (not Dayjs) so the value serializes verbatim into the query string the same way v1 does (`filter=%7B%22$and%22:[%7B%22lockedTs%22:%7B%22$dateOn%22:%222026-02%22%7D%7D]%7D`).
+ * - For relative modes (Today / Past 3 days / This Week / …): a `{ type, number?, unit? }` descriptor that the server resolves to a concrete range at query time.
+ */
+export type DateFilterValue = string | [string, string] | {
+    type: string;
+    number?: number;
+    unit?: 'day' | 'week' | 'month' | 'year';
+} | null | undefined;
+export interface DateFilterDynamicComponentProps {
+    value?: DateFilterValue;
+    onChange?: (value: DateFilterValue) => void;
+    /** `true` for `$dateBetween`; renders a `DatePicker.RangePicker`. */
+    isRange?: boolean;
+    /**
+     * Translator. Defaults to identity so callers can omit it when running outside a translation context (tests, storybook).
+     */
+    t?: (key: string) => string;
+}
+type PickerMode = 'date' | 'month' | 'quarter' | 'year';
+/**
+ * The exact format strings NocoBase's `$date*` server operators expect per picker granularity. Mirrors v1's `getPickerFormat` output under `underFilter=true`, so the URL-encoded query stays identical.
+ *
+ * Exported for unit tests and for downstream callers that need to parse / format `$date*` values outside this component.
+ */
+export declare const FORMAT_BY_PICKER: Record<PickerMode, string>;
+/**
+ * Parse a granularity-formatted string back into a `Dayjs`. Returns `null` on missing or unparseable input so the DatePicker's controlled-value contract stays clean.
+ */
+export declare const parseDateFilterValue: (value: string | undefined, picker: PickerMode) => Dayjs | null;
+/**
+ * Format a `Dayjs` (typically from `DatePicker.onChange`) into the server-facing string at the active picker's granularity. Returns `undefined` for empty input so callers can drop the value entirely.
+ */
+export declare const formatDateFilterValue: (value: Dayjs | null | undefined, picker: PickerMode) => string | undefined;
+/**
+ * v2 port of v1's `DateFilterDynamicComponent` — a multi-mode value input for the `$date*` operator family. Three sub-controls glued in a `Space.Compact` row:
+ *
+ * 1. Mode select — `Exact day` / `Past` / `Next` / `Today` / `This Week` / … Picking a relative mode emits a `{ type, number?, unit? }` descriptor that the server resolves at query time; picking `Exact day` emits a raw `Dayjs` instead.
+ * 2. Picker granularity — only when mode is `Exact day`: `Date` / `Month` / `Quarter` / `Year`. Controls the antd `DatePicker`'s `picker` mode so admins can filter to e.g. "any day in 2026-03".
+ * 3. Date input — antd `DatePicker` for single dates, or `DatePicker.RangePicker` when `isRange` is true (used by `$dateBetween`).
+ *
+ * v1 wired its own `<DatePicker.FilterWithPicker>` for the third slot; v2 inlines the picker-granularity selector here so we don't have to fork antd's DatePicker. Drops v1's `@emotion/css` (uses antd token spacing) and the `useCompile` schema-template chain (call sites pass a plain `t` translator).
+ */
+export declare const DateFilterDynamicComponent: React.FC<DateFilterDynamicComponentProps>;
+export default DateFilterDynamicComponent;

package/es/components/form/filter/FilterValueInput.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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 from 'react';
+import type { FilterOperator, FilterOption } from '../../../flow/components/filter/useFilterOptions';
+export interface FilterValueInputProps {
+    /** The currently selected leaf field option from the field picker. */
+    field?: FilterOption;
+    /** The currently selected operator (full object, not just `.value`). */
+    operator?: FilterOperator;
+    /** Current value. Shape depends on operator/field. */
+    value: any;
+    /** Notify the parent when the user edits the value. */
+    onChange: (value: any) => void;
+    /** Translator used by sub-renderers. */
+    t?: (key: string) => string;
+    /** Optional placeholder for the fallback `Input`. */
+    placeholder?: string;
+}
+/**
+ * Interface-aware value renderer for filter rows. Returns `null` for `noValue` operators (`$empty`, `$notEmpty`). Otherwise dispatches the effective `x-component` (operator schema > field uiSchema > Input) to a small registry of antd controls.
+ */
+export declare const FilterValueInput: React.FC<FilterValueInputProps>;
+export default FilterValueInput;

package/es/components/form/filter/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 { CollectionFilter } from './CollectionFilter';
+export type { CollectionFilterProps } from './CollectionFilter';
+export type { CompiledFilter } from './useFilterActionProps';

package/es/components/form/filter/useFilterActionProps.d.ts

@@ -0,0 +1,96 @@
+/**
+ * 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 { Collection } from '@nocobase/flow-engine';
+import { FilterOption, UseFilterOptionsArgs } from '../../../flow/components/filter/useFilterOptions';
+import { CollectionFilterItemValue, createCollectionFilterItem } from './CollectionFilterItem';
+/** A single condition row (`{ path, operator, value }`) or a nested group. */
+export type FilterGroupItem = CollectionFilterItemValue | FilterGroupValue;
+/**
+ * Reactive shape consumed by `FilterContainer` / `FilterGroup`. `logic` is the join (`$and` / `$or`) and `items` is a heterogeneous list of leaf conditions and nested groups.
+ */
+export type FilterGroupValue = {
+    logic: '$and' | '$or';
+    items: FilterGroupItem[];
+};
+/** Compiled filter param accepted by NocoBase resource `list`. */
+export type CompiledFilter = Record<string, unknown> | undefined;
+interface FilterCtxModel {
+    translate: (key: string) => string;
+    dispatchEvent: (event: 'submit' | 'reset' | (string & {})) => void;
+}
+export interface FilterCtx {
+    model: FilterCtxModel;
+}
+/**
+ * Compile a reactive filter group into the `{ $and: [{ path: { op: val } }] }` envelope accepted by NocoBase's resource `list` filter param. Returns `undefined` when the group is empty so callers can drop the param.
+ *
+ * Mirrors v1's `removeNullCondition` + filter compile path, but works on the v2 `{ logic, items }` group structure rather than v1's Formily-bracketed `$and.0.path.$eq` shape:
+ *
+ * - Rows missing `path` or `operator` are dropped (still mid-edit).
+ * - Rows whose `value` is empty (`undefined`, `''`, `[]`, `{}`) are dropped — matches v1, which sends `filter={}` for a row with only a field/operator picked. Sending `{lockedTs:{}}` would 500.
+ * - Dotted association paths (`user.createdBy.password`) are expanded into nested objects — matches v1's payload shape, which the server resolves along the association chain rather than treating the dotted string as a single key.
+ * - Empty groups (after pruning) propagate as `undefined` so the outermost caller can drop the whole `filter` param.
+ */
+export declare function compileFilterGroup(group: FilterGroupValue | undefined): CompiledFilter;
+/** Which footer button triggered the apply — useful for closing a popover on Submit but keeping it open on Reset. */
+export type FilterApplyAction = 'submit' | 'reset';
+export interface UseFilterActionPropsArgs extends UseFilterOptionsArgs {
+    /** Collection whose fields populate the filter row's field picker. */
+    collection: Collection | undefined;
+    /**
+     * Called when the user submits or resets the filter popover. Receives the compiled filter param (`undefined` when cleared) and which footer button triggered the call. Typical implementation: `(filter, action) => { listRequest.run(filter); if (action === 'submit') closePopover(); }`.
+     */
+    onApply: (filter: CompiledFilter, action: FilterApplyAction) => void;
+}
+export interface UseFilterActionPropsResult {
+    /**
+     * Reactive filter group state. Pass directly to `<FilterContent value={...}>`. Stable across renders.
+     */
+    value: FilterGroupValue;
+    /** Field-option tree (for inspection or custom badges). */
+    options: FilterOption[];
+    /** Bound `FilterItem` component to plug into `<FilterContent FilterItem={...}>`. */
+    FilterItem: ReturnType<typeof createCollectionFilterItem> | undefined;
+    /**
+     * Ready-to-use `ctx` for `<FilterContent ctx={...}>`. Wires Submit / Reset buttons to `onSubmit` / `onReset` below.
+     */
+    ctx: FilterCtx;
+    /** Imperative trigger — submit current group as a compiled filter. */
+    onSubmit: () => void;
+    /** Imperative trigger — clear the group and emit an empty filter. */
+    onReset: () => void;
+    /**
+     * Count of top-level condition rows. Useful for showing a badge like `Filter (3)` on the trigger button — matches v1's `field.title = t('{{count}} filter items', { count })`.
+     */
+    conditionCount: number;
+}
+/**
+ * v2 equivalent of v1's `useFilterActionProps` for non-schema surfaces (settings pages, panels, side drawers). Bundles three things v1's hook returned implicitly through schema:
+ *
+ * - A reactive `{ logic, items }` group state that `<FilterContent>` reads.
+ * - A bound `FilterItem` component (driven by `createCollectionFilterItem`).
+ * - A `ctx` object that turns `<FilterContent>`'s `dispatchEvent('submit' | 'reset')` into a compiled filter param passed to `onApply`.
+ *
+ * Pair with antd `Popover` to recreate the legacy `Filter.Action` UX:
+ *
+ * ```tsx
+ * const { value, ctx, FilterItem, onSubmit, conditionCount } = useFilterActionProps({
+ *   collection,
+ *   onApply: (filter) => listRequest.run(filter),
+ *   t,
+ * });
+ * return (
+ *   <Popover content={<FilterContent value={value} ctx={ctx} FilterItem={FilterItem} />}>
+ *     <Button>{t('Filter')}{conditionCount ? ` (${conditionCount})` : ''}</Button>
+ *   </Popover>
+ * );
+ * ```
+ */
+export declare function useFilterActionProps(args: UseFilterActionPropsArgs): UseFilterActionPropsResult;
+export {};

package/es/components/form/index.d.ts

@@ -7,6 +7,7 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 export * from './createFormRegistry';
+export * from './filter';
 export * from './DialogFormLayout';
 export * from './DrawerFormLayout';
 export * from './EnvVariableInput';

package/es/data-source/ExtendCollectionsProvider.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 { CollectionOptions } from '@nocobase/flow-engine';
+import { FC, ReactNode } from 'react';
+export interface ExtendCollectionsProviderProps {
+    /** Data source key to extend. Defaults to `'main'`. */
+    dataSource?: string;
+    /** Collections to surface for the lifetime of this provider's subtree. */
+    collections: CollectionOptions[];
+    /**
+     * When `true`, re-sync the data source whenever the `collections` prop
+     * reference changes after mount: add entries newly present in the prop and
+     * remove entries no longer present (only those this provider registered).
+     * The diff runs in the same render as the prop change so children see the
+     * new state on their first render — at the cost of one observable mutation
+     * per change.
+     *
+     * Defaults to `false`. Most pages pass a stable (often module-level)
+     * `collections` list and don't need this; leaving it off avoids accidental
+     * re-registration when callers forget to memoize. Enable only when your
+     * collection list legitimately varies during the provider's lifetime.
+     */
+    syncOnChange?: boolean;
+    children?: ReactNode;
+}
+/**
+ * Mount-scoped collection injector. Adds the given `collections` to the target
+ * data source on first render — synchronously, so children can read
+ * `getCollection(name)` on their own first render — and removes them on
+ * unmount. Survives mid-session data-source reloads via the
+ * `dataSource:loaded` event by re-registering only the names this provider
+ * owns.
+ *
+ * Use this for client-only collections — e.g. a `schema-only` server
+ * collection that isn't auto-published to the v2 data source, or a pure
+ * UI-side mirror — so downstream components (like `<CollectionFilter>`) can
+ * resolve the collection by name.
+ *
+ * Default behavior is "static-at-mount": subsequent changes to the
+ * `collections` prop are ignored. Pass `syncOnChange` to opt into diffing on
+ * prop change.
+ */
+export declare const ExtendCollectionsProvider: FC<ExtendCollectionsProviderProps>;
+export default ExtendCollectionsProvider;

package/es/data-source/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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 './ExtendCollectionsProvider';

package/es/flow/FlowPage.d.ts

@@ -6,7 +6,7 @@
  * 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 { FlowModel } from '@nocobase/flow-engine';
+import type { FlowModel, FlowModelRendererProps } from '@nocobase/flow-engine';
 import React from 'react';
 import FlowRoute from './components/FlowRoute';
 type FlowPageProps = {
@@ -14,6 +14,7 @@ type FlowPageProps = {
     parentId?: string;
     onModelLoaded?: (uid: string, model: FlowModel) => void;
     defaultTabTitle?: string;
+    showFlowSettings?: FlowModelRendererProps['showFlowSettings'];
 };
 export declare const FlowPage: React.MemoExoticComponent<(props: FlowPageProps & Record<string, unknown>) => React.JSX.Element>;
 export declare const RemoteFlowModelRenderer: (props: any) => React.JSX.Element;

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

@@ -6,46 +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.
  */
-import { FlowEngine, FlowModel, type ViewParam } from '@nocobase/flow-engine';
-export interface RoutePageMeta {
-    active: boolean;
-    refreshDesktopRoutes?: () => Promise<unknown>;
-    layoutContentElement?: HTMLElement | null;
-}
-interface RouteLike {
-    params?: {
-        name?: string;
-    };
-    pathname?: string;
-}
+import type { FlowEngine } from '@nocobase/flow-engine';
+import { BaseLayoutRouteCoordinator, type BaseLayoutRouteCoordinatorOptions } from './BaseLayoutRouteCoordinator';
 /**
- * 管理 admin 场景下每个 page 的 v2 视图栈编排。
- * 该协调器只负责状态机和开关视图，不直接绑定 React 生命周期。
+ * Admin Layout 路由协调器。
+ *
+ * 该类保留旧导出路径，内部复用通用 BaseLayoutRouteCoordinator。
  */
-export declare class AdminLayoutRouteCoordinator {
-    private readonly flowEngine;
-    private readonly runtimes;
-    private layoutContentElement;
-    private setRuntimeActive;
-    private getCurrentRouteByPageUid;
-    constructor(flowEngine: FlowEngine);
-    setLayoutContentElement(element: HTMLElement | null): void;
-    registerPage(pageUid: string, meta: RoutePageMeta): FlowModel<import("@nocobase/flow-engine").DefaultStructure>;
-    syncPageMeta(pageUid: string, meta: Partial<RoutePageMeta>): void;
-    unregisterPage(pageUid: string): void;
-    syncRoute(routeLike: RouteLike): void;
-    cleanupPage(pageUid: string): void;
-    destroy(): void;
-    private syncRuntimeWithPathname;
-    private shouldStepNavigate;
-    private stepNavigate;
-    private handleOpenViews;
-    private openViews;
-    private ensureRouteModelContext;
-    private getOrCreateRouteModel;
+export declare class AdminLayoutRouteCoordinator extends BaseLayoutRouteCoordinator {
+    constructor(flowEngine: FlowEngine, options?: BaseLayoutRouteCoordinatorOptions);
 }
-/**
- * 将 pathname 解析结果和 pageUid 对齐，便于测试里复用。
- */
-export declare function toViewStack(pathname: string): ViewParam[];
-export {};
+export { toViewStack, type BaseLayoutRouteCoordinatorOptions, type RoutePageMeta } from './BaseLayoutRouteCoordinator';