@nocobase/client-v2 2.2.0-beta.7 → 2.2.0-beta.9

package/es/BaseApplication.d.ts

@@ -12,6 +12,7 @@ import type { i18n as i18next } from 'i18next';
 import React, { ReactElement, ReactNode } from 'react';
 import type { AppListProps } from '@ant-design/pro-layout/es/components/AppsLogoComponents/types';
 import { AIManager } from './ai';
+import { EntryActionManager } from './entry-actions';
 import { SystemSettingsSource } from './flow/system-settings';
 import { LayoutManager } from './layout-manager/LayoutManager';
 import type { PluginClass, PluginManager, PluginType } from './PluginManager';
@@ -75,6 +76,7 @@ export declare abstract class BaseApplication<TOptions extends BaseApplicationOp
     pluginManager: TPluginManager;
     pluginSettingsManager: TPluginSettingsManager;
     layoutManager: LayoutManager<this>;
+    entryActionManager: EntryActionManager;
     aiManager: AIManager;
     devDynamicImport?: DevDynamicImport;
     requirejs: RequireJS;

package/es/RouteRepository.d.ts

@@ -124,6 +124,13 @@ export declare class RouteRepository {
      * @returns 匹配到的路由节点
      */
     getRouteBySchemaUid(schemaUid: string): NocoBaseDesktopRoute | undefined;
+    /**
+     * 通过路由 id 反查对应路由节点。
+     *
+     * @param routeId 桌面路由主键
+     * @returns 匹配到的路由节点
+     */
+    getRouteById(routeId: string | number): NocoBaseDesktopRoute | undefined;
     protected getAPIClient(): APIClient;
     protected getResource(collectionName: string): import("@nocobase/sdk").IResource;
     protected emitChange(layoutUid?: string): void;
@@ -135,5 +142,6 @@ export declare class RouteRepository {
     private nextRefreshRequestId;
     private getRefreshRequestId;
     private findRoute;
+    private findRouteById;
 }
 export {};

package/es/RouterManager.d.ts

@@ -40,9 +40,18 @@ export type RenderComponentType = (Component: ComponentTypeAndString, props?: an
 export type RouterComponentType = React.FC<{
     BaseLayout?: ComponentType;
 }>;
+type AdminRouteNavigationTarget = {
+    currentPathname?: string;
+    targetPathname: unknown;
+    basePath?: string;
+    adminRoutePath?: string;
+    replace?: boolean;
+};
+export declare function shouldOpenAdminRouteInNewWindow(options: AdminRouteNavigationTarget): boolean;
 export declare class RouterManager<TApp extends BaseApplication<any> = BaseApplication<any>> {
     protected routes: Record<string, RouteType>;
     protected options: RouterOptions;
+    private routerNavigate?;
     app: TApp;
     router: Router;
     get basename(): string;
@@ -52,6 +61,11 @@ export declare class RouterManager<TApp extends BaseApplication<any> = BaseAppli
         (to: import("react-router").To, opts?: import("@remix-run/router").RouterNavigateOptions): Promise<void>;
     };
     constructor(options: RouterOptions, app: TApp);
+    private navigateWithPortalPolicy;
+    private shouldOpenAdminRouteInNewWindow;
+    private getRuntimeBasePath;
+    private getAdminRoutePath;
+    private getAdminRouteNavigationHref;
     protected resolveLoadedComponent(moduleOrComponent: ComponentLoaderResult): ComponentTypeAndString | undefined;
     protected createRouteLazyComponent(componentLoader: ComponentLoader): ComponentType;
     /**
@@ -73,3 +87,4 @@ export declare class RouterManager<TApp extends BaseApplication<any> = BaseAppli
     has(name: string): boolean;
     remove(name: string): void;
 }
+export {};

package/es/authRedirect.d.ts

@@ -31,6 +31,7 @@ export declare function getModernClientPrefix(): string;
 export declare function stripModernClientPrefix(publicPath?: string): string;
 export declare function getV2EffectiveBasePath(app: AppLike): string;
 declare function getDefaultV2AdminRedirectPath(app: AppLike): string;
+export declare function normalizeV2RedirectPath(app: AppLike, target?: string | null, fallbackPath?: string): string;
 /**
  * 将当前 v2 页面地址转换为根相对 redirect 路径。
  *

package/es/entry-actions/EntryActionManager.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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, type SubModelItem, type SubModelItemsType } from '@nocobase/flow-engine';
+export type EntryActionScope = 'action-panel' | 'app-switcher' | string;
+export type EntryActionProvider = (ctx: FlowModelContext) => SubModelItem[] | Promise<SubModelItem[]>;
+export declare class EntryActionManager {
+    private readonly providers;
+    revision: number;
+    constructor();
+    register(name: string, options: {
+        scope: EntryActionScope;
+        provider: EntryActionProvider;
+        sort?: number;
+    }): void;
+    unregister(name: string): void;
+    invalidate(): void;
+    getItems(scope: EntryActionScope): SubModelItemsType;
+}

package/es/entry-actions/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 './EntryActionManager';

package/es/flow/actions/afterSuccess.d.ts

@@ -6,4 +6,11 @@
  * 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 afterSuccess: import("@nocobase/flow-engine").ActionDefinition<import("@nocobase/flow-engine").FlowModel<import("@nocobase/flow-engine").DefaultStructure>, import("@nocobase/flow-engine").FlowContext>;
+import { FlowContext, type FlowRuntimeContext, type MetaTreeNode } from '@nocobase/flow-engine';
+type ResponseRecordPlainStepContext = {
+    steps?: FlowRuntimeContext['steps'];
+};
+export declare function getAfterSuccessResponseRecord(ctx: FlowContext | ResponseRecordPlainStepContext): any;
+export declare function getMetaTreeWithResponseRecord(ctx: FlowRuntimeContext): MetaTreeNode[];
+export declare const afterSuccess: import("@nocobase/flow-engine").ActionDefinition<import("@nocobase/flow-engine").FlowModel<import("@nocobase/flow-engine").DefaultStructure>, FlowContext>;
+export {};

package/es/flow/actions/index.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.
  */
-export * from './afterSuccess';
+export { afterSuccess } from './afterSuccess';
 export * from './confirm';
 export * from './dataScope';
 export * from './openView';

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

@@ -41,6 +41,7 @@ export interface LayoutRouteLike {
     id?: string;
     name?: string;
     pathname?: string;
+    state?: unknown;
     params?: Record<string, string | undefined>;
     layoutRouteName?: string;
     layoutBasePathname?: string;
@@ -56,6 +57,7 @@ export declare class BaseLayoutModel<TStructure extends BaseLayoutStructure = Ba
     currentLayoutRoute: LayoutRouteMatch | null;
     protected routeCoordinator?: BaseLayoutRouteCoordinator;
     private activePageUid;
+    private currentRouteState?;
     private layoutContentElement;
     private readonly routePageMetaMap;
     private contextBindingsActive;
@@ -82,6 +84,10 @@ export declare class BaseLayoutModel<TStructure extends BaseLayoutStructure = Ba
     private teardownRuntime;
     private getCurrentRouteByActivePage;
     private getCurrentCoordinatorRouteLike;
+    private restoreCurrentLayoutRouteFromRouterContext;
+    private shouldIgnoreStaleLayoutRouteCleanup;
+    private getRouterContextRouteLike;
+    private isRouteLikeOwnedByCurrentLayout;
 }
 /**
  * 按固定 UID 获取或创建 Layout host model。

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

@@ -25,6 +25,7 @@ interface RouteLike {
         name?: string;
     };
     pathname?: string;
+    state?: unknown;
     pageUid?: string;
     layoutBasePathname?: string;
     layoutRoute?: {
@@ -46,6 +47,7 @@ export declare class BaseLayoutRouteCoordinator {
     private basePathname;
     private readonly runtimes;
     private layoutContentElement;
+    private lastNonNullLayoutContentElement;
     constructor(flowEngine: FlowEngine, options?: BaseLayoutRouteCoordinatorOptions);
     setLayoutContentElement(element: HTMLElement | null): void;
     registerPage(pageUid: string, meta: RoutePageMeta): RouteModel<import("@nocobase/flow-engine").DefaultStructure>;
@@ -62,6 +64,11 @@ export declare class BaseLayoutRouteCoordinator {
     private shouldStepNavigate;
     private scheduleInitialDeepLinkReplay;
     private stepNavigate;
+    private replayActiveRuntimeViewsAfterLayoutContentElementChange;
+    private invalidatePendingRuntimeViewOpens;
+    private resetRuntimeViewStateForLayoutContentElementChange;
+    private markPendingOpenViews;
+    private clearPendingOpenViews;
     private handleOpenViews;
     private openViews;
     private ensureRouteModelContext;

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

@@ -13,6 +13,7 @@ type AdminLayoutContentProps = {
     layout?: (AdminLayoutRoutePathLike & {
         routeName?: string;
     }) | null;
+    designable?: boolean;
 };
 /**
  * AdminLayout 内部使用的内容区容器。

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

@@ -8,4 +8,5 @@
  */
 import type { AppListProps } from '@ant-design/pro-layout/es/components/AppsLogoComponents/types';
 import React from 'react';
-export declare function useAppListRender(): (appList: AppListProps) => React.JSX.Element;
+import type { AppSwitcherActionPanelModel } from './AppSwitcherActionPanelModel';
+export declare function useAppListRender(appSwitcherModel?: AppSwitcherActionPanelModel): (appList: AppListProps) => React.JSX.Element;

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

@@ -0,0 +1,24 @@
+/**
+ * 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 { ActionModel } from '../../models/base';
+import { FlowModel, type SubModelItemsType } from '@nocobase/flow-engine';
+import React from 'react';
+type AppSwitcherActionPanelStructure = {
+    subModels: {
+        actions?: ActionModel[];
+    };
+};
+export declare class AppSwitcherActionPanelModel extends FlowModel<AppSwitcherActionPanelStructure> {
+    getConfigureActionsItems(): SubModelItemsType;
+    renderConfigureActions(): React.JSX.Element;
+    private getRenderableActions;
+    hasActions(): boolean;
+    renderContent(): React.JSX.Element;
+}
+export {};

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

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

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

@@ -6,8 +6,13 @@
  * 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 { AppListProps } from '@ant-design/pro-layout/es/components/AppsLogoComponents/types';
 import React from 'react';
-export declare const useApplications: () => {
+import type { AdminLayoutModel } from './AdminLayoutModel';
+import type { AppSwitcherActionPanelModel } from './AppSwitcherActionPanelModel';
+export declare const APP_SWITCHER_ACTION_PANEL_MODEL_UID: string;
+export declare const useApplications: (adminLayoutModel?: AdminLayoutModel) => {
     Component: React.JSXElementConstructor<any> | React.ExoticComponent<any>;
-    appList: any[];
+    appList: AppListProps;
+    appSwitcherModel: AppSwitcherActionPanelModel;
 };

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

@@ -30,6 +30,7 @@ export declare class ActionModel<T extends DefaultStructure = DefaultStructure>
     enableEditTooltip: boolean;
     enableEditTitle: boolean;
     enableEditIcon: boolean;
+    enableEditIconOnly: boolean;
     enableEditType: boolean;
     enableEditDanger: boolean;
     enableEditColor: boolean;
@@ -44,6 +45,7 @@ export declare class ActionModel<T extends DefaultStructure = DefaultStructure>
     getInputArgs(): Record<string, any>;
     onClick(event: any): void;
     getTitle(): string;
+    getTitleFieldDescription(): any;
     getIcon(): React.ReactNode;
     renderButton(): React.JSX.Element;
     render(): React.JSX.Element;

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

@@ -6,4 +6,4 @@
  * 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 function submitHandler(ctx: any, params: any, cb?: (values?: any, filterByTk?: any) => void): Promise<void>;
+export declare function submitHandler(ctx: any, params: any, cb?: (values?: any, filterByTk?: any) => void): Promise<unknown>;

package/es/flow/models/blocks/form/value-runtime/runtime.d.ts

@@ -12,6 +12,10 @@ import type { FormAssignRuleItem, NamePath, Patch, SetOptions } from './types';
 type FormBlockModel = FlowModel & {
     getAclActionName?: () => string;
 };
+export type FormValuePatch = {
+    path: NamePath;
+    value: unknown;
+};
 export declare class FormValueRuntime {
     private readonly model;
     private readonly getForm;
@@ -50,6 +54,8 @@ export declare class FormValueRuntime {
     syncAssignRules(items: FormAssignRuleItem[]): void;
     get formValues(): any;
     getFormValuesSnapshot(): any;
+    getUserEditedValuePatches(): FormValuePatch[];
+    getUserEditedValuesSnapshot(): Record<string, unknown>;
     private toMirrorSnapshot;
     canApplyDefaultValuePatch(namePath: NamePath, resolved: any): boolean;
     canApplyOverrideValuePatch(namePath: NamePath): boolean;
@@ -111,6 +117,9 @@ export declare class FormValueRuntime {
     private isExplicit;
     private findExplicitHit;
     private findUserEditedHit;
+    private findLatestWriteMeta;
+    private isCurrentUserEditedPath;
+    private omitNonUserDescendantValues;
     private isDescendantPathKey;
 }
 export {};

package/es/flow/models/blocks/js-block/JSBlock.d.ts

@@ -10,6 +10,7 @@ import React from 'react';
 import { BlockModel } from '../../base';
 export declare class JSBlockModel extends BlockModel {
     private _mountedOnce;
+    get showBlockCard(): boolean;
     renderComponent(): React.ReactNode;
     render(): React.JSX.Element;
     protected onMount(): void;

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

@@ -8,6 +8,7 @@
  */
 import React from 'react';
 import { TableCustomColumnModel } from './TableCustomColumnModel';
+export declare const tableRowActionsClassName: string;
 export declare class TableActionsColumnModel extends TableCustomColumnModel {
     afterAddAsSubModel(): Promise<void>;
     getColumnProps(): {

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

@@ -64,6 +64,7 @@ export declare class TableBlockModel extends CollectionBlockModel<TableBlockMode
     isRowSelectionEnabled(): boolean;
     isShowIndexEnabled(): boolean;
     getRecordIndex(record: Record<string, unknown>, index: number): string | number;
+    getDragSortFieldName(): string | undefined;
     getLeftAuxiliaryColumn(): {
         key: string;
         width: number;

package/es/flow/models/blocks/table/dragSort/dragSortHooks.d.ts

@@ -8,7 +8,7 @@
  */
 import React from 'react';
 import type { TableBlockModel } from '../TableBlockModel';
-export declare function useDragSortBodyWrapper(model: TableBlockModel, dataSourceRef: React.MutableRefObject<any>, getRowKeyFunc: (record: any) => string | number): (props: any) => React.JSX.Element;
+export declare function useDragSortBodyWrapper(model: TableBlockModel, dataSourceRef: React.MutableRefObject<any>, getRowKeyFunc: (record: any) => string | number, dragSortFieldName?: string): (props: any) => React.JSX.Element;
 export declare function useDragSortRowComponent(dragSort: boolean): React.FC<{
     [key: string]: any;
     rowIndex?: number;

package/es/flow/models/blocks/table/dragSort/dragSortSettings.d.ts

@@ -15,7 +15,7 @@ export declare const dragSortSettings: {
     defaultParams: {
         dragSort: boolean;
     };
-    handler(ctx: any, params: any): Promise<void>;
+    handler(ctx: any, params: any): void;
 };
 export declare const dragSortBySettings: {
     title: string;
@@ -29,6 +29,7 @@ export declare const dragSortBySettings: {
                 value: any;
                 disabled: any;
             }[];
+            allowClear: boolean;
             placeholder: any;
         };
     };

package/es/flow/models/blocks/table/dragSort/dragSortUtils.d.ts

@@ -6,25 +6,27 @@
  * 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 { Collection, CollectionField } from '@nocobase/flow-engine';
 /**
  * 从 collection 中获取所有 sort 类型的字段
  * @param collection - 集合对象
  * @returns 排序字段数组
  */
-export declare function getSortFields(collection: Collection | undefined): import("@nocobase/flow-engine").CollectionField[];
+export declare function getSortFields(collection: Collection | undefined): CollectionField[];
+export declare function getSortField(collection: Collection | undefined, fieldName?: string | null): CollectionField | undefined;
+export declare function hasSortField(collection: Collection | undefined, fieldName?: string | null): boolean;
 /**
  * 获取 collection 中第一个可用的 sort 字段
  * @param collection - 集合对象
  * @returns 第一个排序字段，如果没有则返回 undefined
  */
-export declare function getFirstSortField(collection: Collection | undefined): import("@nocobase/flow-engine").CollectionField;
+export declare function getFirstSortField(collection: Collection | undefined): CollectionField;
 /**
  * 将 sort 字段转换为选项格式
  * @param fields - 字段数组
  * @returns 选项数组
  */
-export declare function convertFieldsToOptions(fields: any[]): {
+export declare function convertFieldsToOptions(fields: CollectionField[]): {
     label: any;
     value: any;
     disabled: any;

package/es/flow/resolveViewParamsToViewList.d.ts

@@ -17,4 +17,4 @@ export interface ViewItem {
     index: number;
 }
 export declare function resolveViewParamsToViewList(flowEngine: FlowEngine, viewParams: ViewParam[], routeModel: FlowModel): ViewItem[];
-export declare function updateViewListHidden(viewItems: ViewItem[]): void;
+export declare function updateViewListHidden(viewItems: ViewItem[], isMobileLayout?: boolean): void;

package/es/flow/routeTransientInputArgs.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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 ROUTE_TRANSIENT_INPUT_ARGS_KEY = "__nocobaseOpenViewInputArgs";
+export type RouteTransientInputArgsState = {
+    [ROUTE_TRANSIENT_INPUT_ARGS_KEY]?: Record<string, Record<string, unknown>>;
+    usr?: RouteTransientInputArgsState;
+};
+export declare const getRouteTransientInputArgs: (state: unknown, viewUid?: string) => Record<string, unknown>;

package/es/index.d.ts

@@ -36,7 +36,9 @@ export * from './collection-manager/filter-operators';
 export * from './collection-manager/interfaces';
 export * from './collection-manager/template-fields';
 export * from './data-source';
+export * from './entry-actions';
 export * from './flow';
 export { DEFAULT_DATA_SOURCE_KEY, IconPicker, isTitleField, isTitleFieldInterface, NocoBaseDesktopRouteType, } from './flow-compat';
 export type { NocoBaseDesktopRoute } from './flow-compat';
+export * from './utils/markdownSanitize';
 export { default as AntdAppProvider } from './theme/AntdAppProvider';