@nocobase/client-v2 2.3.0-alpha.1 → 3.0.0-alpha.2

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/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;
     };

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/form/ScanInput/useCodeScanner.d.ts

@@ -15,7 +15,6 @@ type UseCodeScannerOptions = {
     enabled: boolean;
     elementId: string;
     formatsToSupport?: CodeFormatsToSupport;
-    scanBoxSize?: ScannerSize;
     onScannerSizeChanged?: (size: ScannerSize) => void;
     onScanSuccess: (text: string) => void;
     onScanFailure?: () => void;
@@ -26,7 +25,8 @@ export declare function getCodeScanBoxSize(width: number, height: number): {
     width: number;
     height: number;
 };
-export declare function useCodeScanner({ enabled, elementId, formatsToSupport, scanBoxSize, onScannerSizeChanged, onScanSuccess, onScanFailure, onCameraStartFailure, }: UseCodeScannerOptions): {
+export declare function scanQrVideoFrame(video: HTMLVideoElement, canvas: HTMLCanvasElement): string;
+export declare function useCodeScanner({ enabled, elementId, formatsToSupport, onScannerSizeChanged, onScanSuccess, onScanFailure, onCameraStartFailure, }: UseCodeScannerOptions): {
     startScanFile: (file: File) => Promise<void>;
 };
 export {};

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/actions/linkageRules.d.ts

@@ -7,6 +7,7 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 import { FlowContext, FlowModel } from '@nocobase/flow-engine';
+export declare function updateLinkageRules<T>(rules: T[], updater: (nextRules: T[]) => void): T[];
 export declare const linkageSetBlockProps: import("@nocobase/flow-engine").ActionDefinition<FlowModel<import("@nocobase/flow-engine").DefaultStructure>, FlowContext>;
 export declare const linkageSetActionProps: import("@nocobase/flow-engine").ActionDefinition<FlowModel<import("@nocobase/flow-engine").DefaultStructure>, FlowContext>;
 export declare const linkageSetMenuItemProps: import("@nocobase/flow-engine").ActionDefinition<FlowModel<import("@nocobase/flow-engine").DefaultStructure>, FlowContext>;

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/FlowRoute.d.ts

@@ -19,8 +19,8 @@ export type FlowRouteProps = {
 /**
  * 管理后台动态页面路由组件。
  *
- * 负责读取当前路由页面 UID，补充运行时设备变量，
- * 并把页面生命周期桥接到 AdminLayout host model。
+ * 负责读取当前路由页面 UID，并把页面生命周期桥接到 AdminLayout host model。
+ * 设备变量通常由 PluginFlowEngine 共享初始化提供；独立渲染时会在挂载后补充注册。
  *
  * @example
  * ```tsx

package/es/flow/internal/registerDeviceTypeContext.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 type { FlowEngine } from '@nocobase/flow-engine';
+export declare const registerDeviceTypeContext: (flowEngine: FlowEngine) => void;

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

@@ -6,7 +6,8 @@
  * 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, FlowModel } from '@nocobase/flow-engine';
+import { FlowModel } from '@nocobase/flow-engine';
+import type { DefaultStructure, FlowModelOptions } from '@nocobase/flow-engine';
 import type { ButtonProps } from 'antd/es/button';
 import React from 'react';
 export declare function ActionWithoutPermission(props: any): React.JSX.Element;
@@ -41,7 +42,8 @@ export declare class ActionModel<T extends DefaultStructure = DefaultStructure>
     static _getScene(): any[];
     static _isScene(scene: ActionSceneType): boolean;
     getAclActionName(): any;
-    onInit(options: any): void;
+    onInit(options: FlowModelOptions<T>): void;
+    serialize(): Record<string, any>;
     getInputArgs(): Record<string, any>;
     onClick(event: any): void;
     getTitle(): string;

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

@@ -11,8 +11,11 @@ import React from 'react';
 import { FilterManager } from '../blocks/filter-manager/FilterManager';
 import { GridModel } from './GridModel';
 export declare class BlockGridModel extends GridModel {
+    private viewActivatedListener?;
     dragOverlayConfig: DragOverlayConfig;
     onInit(options: any): void;
+    onMount(): void;
+    protected onUnmount(): void;
     get subModelBaseClasses(): string[];
     get filterManager(): FilterManager;
     get addBlockItems(): SubModelItemsType | undefined;

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

@@ -23,6 +23,7 @@ export declare class TableColumnModel extends DisplayItemModel {
     afterAddAsSubModel(): Promise<void>;
     renderHiddenInConfig(): React.ReactNode | undefined;
     static defineChildren(ctx: FlowModelContext): any;
+    canQuickEdit(record: Record<string, unknown>): boolean;
     getColumnProps(): TableColumnProps & {
         sortField?: string;
     };

package/es/flow/models/fields/DateTimeFieldModel/dateLimit.d.ts

@@ -6,15 +6,23 @@
  * 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';
 type DateLimitProps = {
-    _minDate?: any;
-    _maxDate?: any;
-    currentForm?: any;
+    _minDate?: unknown;
+    _maxDate?: unknown;
+    currentForm?: unknown;
 };
+type DisabledTimeConfig = {
+    disabledHours: () => number[];
+    disabledMinutes: (selectedHour: number) => number[];
+    disabledSeconds: (selectedHour: number, selectedMinute: number) => number[];
+};
+type DisabledDate = (current: Dayjs) => boolean;
+type DisabledTime = (current: Dayjs | null) => DisabledTimeConfig;
 export declare function useDateLimit(props: DateLimitProps): {
-    minDate: any;
-    maxDate: any;
-    disabledDate: any;
-    disabledTime: any;
+    minDate: Dayjs;
+    maxDate: Dayjs;
+    disabledDate: DisabledDate;
+    disabledTime: DisabledTime;
 };
 export {};

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, 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';
@@ -46,3 +47,5 @@ export { DEFAULT_DATA_SOURCE_KEY, IconPicker, isTitleField, isTitleFieldInterfac
 export type { NocoBaseDesktopRoute } from './flow-compat';
 export * from './utils/markdownSanitize';
 export { default as AntdAppProvider } from './theme/AntdAppProvider';
+export { isSettingsApp } from './settings-app/isSettingsApp';
+export { MINIMAL_THEME_UID, useSettingsThemeConfig } from './settings-app/useSettingsThemeConfig';