@nocobase/client-v2 2.3.0-beta.9 → 2.4.0-alpha.10

package/es/RouteRepository.d.ts

@@ -72,6 +72,12 @@ export declare class RouteRepository {
      * @returns 当前可访问的路由数组
      */
     ensureAccessibleLoaded(): Promise<any>;
+    /**
+     * 清空所有布局的路由缓存，并丢弃清空前发起的请求结果。
+     *
+     * 用于登录态失效（如退出登录）时，避免下一个用户沿用上一个用户的可访问路由。
+     */
+    clear(): void;
     /**
      * 订阅路由缓存变化，用于驱动 React 上下文刷新。
      *

package/es/acl/ACLProvider.d.ts

@@ -43,6 +43,16 @@ export declare const ACLRolesCheckProvider: FC;
  * 返回原始 ACL provider 上下文。
  */
 export declare const useACLContext: () => ACLContextValue;
+/**
+ * 读取当前角色的 snippets，且不要求调用方位于 `ACLRolesCheckProvider` 之内。
+ *
+ * 设置中心顶栏导航挂在 app 级 provider 上，位置比 `ACLRolesCheckProvider` 更外层，
+ * 这种情况下退回到 app context 上的 ACL observable store。
+ * 调用方需要用 `observer` 包裹，store 更新后才会重新渲染。
+ *
+ * @returns {string[]} 当前角色的 snippets
+ */
+export declare const useACLSnippets: () => string[];
 /**
  * 触发当前角色权限重新检查。
  */

package/es/acl/aclCheckReadiness.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 function getACLCheckReady(app: object): boolean;
+export declare function setACLCheckReady(app: object, ready: boolean): void;
+export declare function useACLCheckReady(app: object): boolean;

package/es/authRedirect.d.ts

@@ -8,6 +8,11 @@
  */
 import type { BaseApplication } from './BaseApplication';
 type AppLike = Pick<BaseApplication<any>, 'getPublicPath'> & {
+    name?: string;
+    pluginSettingsManager?: {
+        getRouteName?: (name: string) => string;
+        getRoutePath?: (name: string) => string;
+    };
     router?: {
         getBasename?: () => string | undefined;
     };
@@ -45,18 +50,22 @@ export declare function getCurrentV2RedirectPath(app: AppLike, locationLike: Loc
  *
  * @param app 当前 v2 应用实例
  * @param targetPath 登录后回跳地址
+ * @param options 可选的登录路由配置
  * @returns 指向 v2 登录页的 href
  */
-export declare function buildV2SigninHref(app: AppLike, targetPath: string): string;
+export declare function buildV2SigninHref(app: AppLike, targetPath: string, options?: {
+    signInRoutePath?: string;
+}): string;
 /**
  * 通过整页跳转进入 v2 登录页。
  *
  * @param app 当前 v2 应用实例
  * @param targetPath 登录后回跳地址
- * @param options 跳转选项
+ * @param options 跳转和登录路由选项
  */
 export declare function redirectToV2Signin(app: AppLike, targetPath: string, options?: {
     replace?: boolean;
+    signInRoutePath?: string;
 }): void;
 /**
  * 解析并校验服务端返回的 v2 登录页地址。

package/es/components/AttachmentUpload.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 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';
+export type UploadedAttachment = {
+    id?: number;
+    title?: string;
+    filename?: string;
+    url?: string;
+};
+export type AttachmentStorageRules = {
+    size?: number;
+    mimetype?: string | string[];
+};
+/**
+ * 读取默认附件存储的上传限制。
+ *
+ * 校验交给存储自身的配置（大小、mimetype），而不是在每个调用点各写一套硬编码规则。
+ *
+ * @returns {AttachmentStorageRules | null} 存储规则，取不到时为 null
+ */
+export declare function useAttachmentStorageRules(): AttachmentStorageRules;
+export type AttachmentUploadProps = {
+    value?: UploadedAttachment | null;
+    onChange?: (value: UploadedAttachment | null) => void;
+    /** 卡片尺寸；`fit` 对应 CSS object-fit */
+    preview?: {
+        width?: number;
+        height?: number;
+        fit?: 'contain' | 'cover';
+    };
+    /** 在存储规则之外再收窄可选文件类型，例如只收图片 */
+    accept?: string;
+    /** 上传卡片里 `+` 下方的文字 */
+    uploadText?: string;
+    disabled?: boolean;
+};
+/**
+ * 附件上传控件。
+ *
+ * 受控组件，值就是 `attachments:create` 返回的附件对象，可直接挂在 `Form.Item` 上。
+ * 外观沿用附件字段的原生形态：一张 picture-card，删除在卡片自身的悬浮操作里，不额外摆按钮。
+ * 上传前按默认存储的规则校验大小与 mimetype，与业务表单里的附件字段保持同一套限制。
+ */
+export declare const AttachmentUpload: React.FC<AttachmentUploadProps>;
+export default AttachmentUpload;

package/es/components/index.d.ts

@@ -7,6 +7,7 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 export * from './AppComponents';
+export * from './AttachmentUpload';
 export * from './BlankComponent';
 export * from './category-tabs';
 export * from './form/table/dnd';

package/es/flow/admin-shell/admin-layout/NocoBaseLogo.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 React from 'react';
+export declare const NocoBaseLogo: React.MemoExoticComponent<import("@formily/reactive-react").ReactFC<unknown>>;

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

@@ -27,7 +27,9 @@ export interface VariableFilterItemProps {
     rightAsVariable?: boolean;
     /**
      * 右侧 VariableInput 的 metaTree 提供器；
-     * 默认使用整棵 ctx 的 metaTree：model.context.getPropertyMetaTree()
+     * 默认使用视图上下文的 metaTree：useFlowViewContext().getPropertyMetaTree()。
+     * 注意它取自视图上下文而非 `model.context`：当调用方传入的 model 与打开设置弹窗的模型不是同一个时，
+     * 右侧变量不会跟随 model 变化，需要显式传入本属性。
      */
     rightMetaTree?: MetaTreeNode[] | (() => MetaTreeNode[] | Promise<MetaTreeNode[]>);
     /**
@@ -36,6 +38,13 @@ export interface VariableFilterItemProps {
     rightVariableConverters?: Pick<Converters, 'resolvePathFromValue' | 'resolveValueFromPath'>;
     ignoreFieldNames?: string[];
     maxAssociationFieldDepth?: number;
+    /**
+     * 右侧变量树的关联层级上限，默认与 `maxAssociationFieldDepth` 一致。
+     * 传 `null` 表示不限制：右侧是变量树而非集合字段树，其深度可能已由调用方约束
+     * （例如工作流的变量树由触发器的「预加载关系数据」决定），此时再按左侧的层级上限裁剪
+     * 会让已配置好的深层变量选不到。
+     */
+    rightMaxAssociationFieldDepth?: number | null;
 }
 /**
  * 上下文筛选项组件

package/es/flow/internal/utils/quickEditDataScope.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 { FlowEngineContext, ModelConstructor } from '@nocobase/flow-engine';
+import { CollectionField, FlowModel } from '@nocobase/flow-engine';
+import React from 'react';
+export declare const QUICK_EDIT_DATA_SCOPE_FLOW_KEY = "tableColumnSettings";
+export declare const QUICK_EDIT_DATA_SCOPE_STEP_KEY = "quickEditDataScope";
+export type DataScopeStepLocation = {
+    flowKey: string;
+    stepKey: string;
+};
+type DataScopeFilter = {
+    logic?: string;
+    items?: unknown[];
+} | undefined;
+/**
+ * Locate the flow and step that carry the shared `dataScope` action on a field model class. Both association editors
+ * currently keep it under `selectSettings`, but the lookup resolves it from the class instead of hard-coding that name,
+ * so an editor registered later is picked up without touching the quick edit path. Returns the first match.
+ */
+export declare function findDataScopeStep(ModelClass: ModelConstructor | typeof FlowModel | undefined | null): DataScopeStepLocation | null;
+/**
+ * Resolve the data scope step of the editor model that the quick edit popover builds for `collectionField`. Returns null
+ * when the field is not an association or when its default editor has no data scope step, which is what the column
+ * setting uses to decide whether to offer the item at all.
+ */
+export declare function resolveQuickEditDataScopeStep(ctx: FlowEngineContext, collectionField: CollectionField): DataScopeStepLocation | null;
+export declare function isEmptyDataScopeFilter(filter: DataScopeFilter): boolean;
+/** Read the quick edit data scope filter stored on the table column that owns `sourceFieldModel`. */
+export declare function getQuickEditDataScopeFilter(sourceFieldModel?: FlowModel): DataScopeFilter;
+/**
+ * Context the filter builder is configured against. The setting lives on the table column, but the filter describes
+ * records of the association target, so `collection` points at the target collection to drive the left-hand field list.
+ * `record` is declared with meta only so that "Current record" is offered as a right-hand variable and describes the row
+ * being edited rather than whatever record an enclosing popup happens to supply; it has no value while configuring and
+ * resolves per row once the popover opens.
+ */
+export declare function createQuickEditDataScopeContext(columnModel: FlowModel): Promise<import("@nocobase/flow-engine").FlowModelContext>;
+export declare function QuickEditDataScopeInput(props: {
+    value?: Record<string, any>;
+}): React.JSX.Element;
+export {};

package/es/flow/internal/utils/quickEditViewContainer.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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.
+ */
+type QuickEditViewContainerLike = {
+    update?: (newConfig: {
+        preventClose?: boolean;
+    }) => unknown;
+};
+type QuickEditFieldModelLike = {
+    parent?: {
+        use?: string;
+        viewContainer?: QuickEditViewContainerLike;
+    } | null;
+};
+export declare function getQuickEditViewContainer(model: QuickEditFieldModelLike | undefined): QuickEditViewContainerLike;
+/**
+ * Keeps the quick edit popover open while a nested dropdown (Select / Cascader) is open. The outside click that
+ * closes the dropdown would otherwise also close the popover and drop the unsaved edit. Releasing is deferred so the
+ * closing click itself never reaches the popover as a close request.
+ */
+export declare function syncQuickEditPreventClose(model: QuickEditFieldModelLike | undefined, dropdownOpen: boolean): void;
+export {};

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

@@ -37,6 +37,7 @@ export declare class QuickEditFormModel extends FlowModel {
     __onSubmitSuccess: any;
     _fieldProps: any;
     _onOk: any;
+    _dataScopeFilter: Record<string, any> | undefined;
     get form(): any;
     useHooksBeforeRender(): void;
     static open(options: {

package/es/index.d.ts

@@ -27,7 +27,8 @@ export * from './PluginSettingsManager';
 export * from './layout-manager';
 export * from './hooks';
 export { default as languageCodes } from './locale/languageCodes';
-export * from './nocobase-buildin-plugin';
+export { CurrentUserContext, NocoBaseBuildInPlugin, NocoBaseBuildInPluginV2, resolveUnauthenticatedSignInRoute, useCurrentRoles, useCurrentUserContext, } from './nocobase-buildin-plugin';
+export type { CurrentRoleOption, CurrentUserState } from './nocobase-buildin-plugin';
 export { getRouteRuntimeVersion } from './utils/getRouteRuntimeVersion';
 export type { RouteRuntimeVersion } from './utils/getRouteRuntimeVersion';
 export * from './collection-field-interface/CollectionFieldInterface';
@@ -47,3 +48,5 @@ export type { NocoBaseDesktopRoute } from './flow-compat';
 export * from './utils/markdownSanitize';
 export * from './ui-operation';
 export { default as AntdAppProvider } from './theme/AntdAppProvider';
+export { isSettingsApp } from './settings-app/isSettingsApp';
+export { MINIMAL_THEME_UID, useSettingsThemeConfig } from './settings-app/useSettingsThemeConfig';