@nocobase/client 1.5.0-beta.1 → 1.5.0-beta.10

package/es/acl/style.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 const useStyles: (props?: unknown) => import("antd-style").ReturnStyles<import("antd-style").SerializedStyles>;
+export declare const antTableCell: string;

package/es/api-client/hooks/useRequest.d.ts

@@ -7,8 +7,8 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 import { Options, Result } from 'ahooks/es/useRequest/src/types';
-import { AxiosRequestConfig } from 'axios';
 import { SetState } from 'ahooks/lib/useSetState';
+import { AxiosRequestConfig } from 'axios';
 type FunctionService = (...args: any[]) => Promise<any>;
 export type ReturnTypeOfUseRequest<TData = any> = ReturnType<typeof useRequest<TData>>;
 export type ResourceActionOptions<P = any> = {

package/es/application/CustomRouterContextProvider.d.ts

@@ -6,18 +6,46 @@
  * 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 { Schema } from '@formily/json-schema';
 import React, { FC } from 'react';
 import { Location, NavigateFunction } from 'react-router-dom';
 export declare const LocationSearchContext: React.Context<string>;
 /**
- * use `useNavigateNoUpdate` to avoid components that use `useNavigateNoUpdate` re-rendering.
+ * @internal
+ */
+export declare const CurrentPageUidContext: React.Context<string>;
+/**
+ * @internal
+ */
+export declare const CurrentTabUidContext: React.Context<string>;
+export declare const IsSubPageClosedByPageMenuProvider: FC;
+export declare const CurrentPageUidProvider: FC;
+export declare const CurrentTabUidProvider: FC;
+/**
+ * use `useNavigateNoUpdate` to avoid components re-rendering.
  * @returns
  */
 export declare const useNavigateNoUpdate: () => NavigateFunction;
 /**
- * use `useLocationNoUpdate` to avoid components that use `useLocationNoUpdate` re-rendering.
+ * use `useLocationNoUpdate` to avoid components re-rendering.
  * @returns
  */
 export declare const useLocationNoUpdate: () => Location<any>;
 export declare const useLocationSearch: () => string;
+export declare const useIsAdminPage: () => boolean;
+export declare const useCurrentPageUid: () => string;
+export declare const useMatchAdmin: () => boolean;
+export declare const useMatchAdminName: () => boolean;
+export declare const useIsInSettingsPage: () => boolean;
+/**
+ * @internal
+ */
+export declare const useCurrentTabUid: () => string;
+export declare const useCurrentSearchParams: () => URLSearchParams;
+export declare const useRouterBasename: () => string;
+/**
+ * Used to determine if the user closed the sub-page by clicking on the page menu
+ * @returns
+ */
+export declare const useIsSubPageClosedByPageMenu: (fieldSchema: Schema) => boolean;
 export declare const CustomRouterContextProvider: FC;

package/es/application/hooks/index.d.ts

@@ -10,4 +10,3 @@ export * from './useApp';
 export * from './useAppSpin';
 export * from './usePlugin';
 export * from './useRouter';
-export * from './useRouterBasename';

package/es/application/schema-initializer/context/index.d.ts

@@ -20,5 +20,5 @@ export declare const useSchemaInitializer: () => {
     visible: boolean;
     setVisible: (v: boolean) => void;
 };
-export declare const SchemaInitializerItemContext: React.Context<Omit<SchemaInitializerItemType, "type" | "sort" | "component" | "Component" | "componentProps" | "useVisible" | "useChildren" | "hideIfNoChildren">>;
+export declare const SchemaInitializerItemContext: React.Context<Omit<SchemaInitializerItemType, "type" | "sort" | "component" | "componentProps" | "Component" | "useVisible" | "useChildren" | "hideIfNoChildren">>;
 export declare const useSchemaInitializerItem: <T = any>() => T;

package/es/application/schema-initializer/types.d.ts

@@ -75,7 +75,7 @@ export interface SchemaInitializerOptions<P1 = ButtonProps, P2 = {}> {
     insertPosition?: 'beforeBegin' | 'afterBegin' | 'beforeEnd' | 'afterEnd';
     designable?: boolean;
     wrap?: (s: ISchema, options?: any) => ISchema;
-    useWrap?: () => ((s: ISchema, options?: any) => ISchema);
+    useWrap?: () => (s: ISchema, options?: any) => ISchema;
     onSuccess?: (data: any) => void;
     insert?: InsertType;
     useInsert?: () => InsertType;

package/es/block-provider/BlockProvider.d.ts

@@ -23,7 +23,6 @@ export declare const BlockRequestContext_deprecated: React.Context<{
     field?: GeneralField;
     service?: any;
     resource?: any;
-    allowedActions?: any;
     __parent?: any;
     updateAssociationValues?: any[];
 }>;
@@ -56,7 +55,6 @@ export declare const useBlockRequestContext: () => {
     field?: GeneralField;
     service?: any;
     resource?: any;
-    allowedActions?: any;
     __parent?: any;
     updateAssociationValues?: any[];
 };

package/es/block-provider/TableBlockProvider.d.ts

@@ -20,3 +20,14 @@ export declare const TableBlockProvider: React.FunctionComponent<any>;
  * @internal
  */
 export declare const useTableBlockContext: () => any;
+/**
+ * @internal
+ */
+export declare const useTableBlockContextBasicValue: () => {
+    field: any;
+    rowKey: string;
+    dragSortBy?: string;
+    childrenColumnName?: string;
+    showIndex?: boolean;
+    dragSort?: boolean;
+};

package/es/block-provider/TemplateBlockProvider.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 React from 'react';
+import { FC } from 'react';
 /**
  * @internal
  */
@@ -14,5 +14,7 @@ export declare const useTemplateBlockContext: () => {
     templateFinished?: boolean;
     onTemplateSuccess?: Function;
 };
-declare const TemplateBlockProvider: (props: any) => React.JSX.Element;
+declare const TemplateBlockProvider: FC<{
+    onTemplateLoaded?: () => void;
+}>;
 export { TemplateBlockProvider };

package/es/block-provider/hooks/index.d.ts

@@ -74,9 +74,6 @@ export declare const useRemoveActionProps: (associationName: any) => {
 export declare const useDisassociateActionProps: () => {
     onClick(e?: any, callBack?: any): Promise<void>;
 };
-export declare const useDetailPrintActionProps: () => {
-    onClick(): Promise<void>;
-};
 export declare const useBulkDestroyActionProps: () => {
     onClick(e?: any, callBack?: any): Promise<void>;
 };
@@ -156,7 +153,7 @@ export declare const getAppends: ({ schema, prefix: defaultPrefix, updateAssocia
 }) => void;
 export declare const useAssociationNames: (dataSource?: string) => {
     getAssociationAppends: () => {
-        appends: any[];
+        appends: any;
         updateAssociationValues: any[];
     };
 };

package/es/collection-manager/CollectionManagerProvider.d.ts

@@ -12,5 +12,6 @@ import { CollectionManagerOptions } from './types';
  * @deprecated use `CollectionManagerProvider` instead
  */
 export declare const CollectionManagerProvider_deprecated: React.FC<CollectionManagerOptions>;
+export declare const useRemoteCollectionManagerLoading: () => boolean;
 export declare const RemoteCollectionManagerProvider: (props: any) => React.JSX.Element;
 export declare const CollectionCategoriesProvider: (props: any) => React.JSX.Element;

package/es/collection-manager/action-hooks.d.ts

@@ -84,7 +84,7 @@ export declare const useBulkDestroyActionAndRefreshCM: () => {
     run(): Promise<void>;
 };
 export declare const useFilterActionProps: () => {
-    options: any;
-    onSubmit(values: any): any;
-    onReset(): any;
+    options: any[];
+    onSubmit: (values: any) => any;
+    onReset: () => any;
 };

package/es/collection-manager/hooks/useDialect.d.ts

@@ -8,6 +8,6 @@
  */
 declare const useDialect: () => {
     isDialect: (dialect: string) => boolean;
-    dialect: string;
+    dialect: any;
 };
 export default useDialect;

package/es/collection-manager/interfaces/index.d.ts

@@ -40,7 +40,6 @@ export * from './time';
 export * from './updatedAt';
 export * from './updatedBy';
 export * from './url';
-export * from './sort';
 export * from './uuid';
 export * from './nanoid';
 export * from './unixTimestamp';

package/es/collection-manager/templates/sql.d.ts

@@ -31,14 +31,14 @@ export declare class SqlCollectionTemplate extends CollectionTemplate {
         name: any;
         title: any;
         description: any;
-        inherits: any;
-        sortable: any;
-        autoGenId: any;
-        category: any;
         createdBy: any;
-        updatedBy: any;
         createdAt: any;
+        updatedBy: any;
         updatedAt: any;
+        category: any;
+        sortable: any;
+        inherits: any;
+        autoGenId: any;
         simplePaginate: any;
         presetFields: any;
         config: {

package/es/collection-manager/templates/view.d.ts

@@ -21,14 +21,14 @@ export declare class ViewCollectionTemplate extends CollectionTemplate {
         name: any;
         title: any;
         description: any;
-        inherits: any;
-        sortable: any;
-        autoGenId: any;
-        category: any;
         createdBy: any;
-        updatedBy: any;
         createdAt: any;
+        updatedBy: any;
         updatedAt: any;
+        category: any;
+        sortable: any;
+        inherits: any;
+        autoGenId: any;
         simplePaginate: any;
         presetFields: any;
         databaseView: {
@@ -101,6 +101,7 @@ export declare class ViewCollectionTemplate extends CollectionTemplate {
             type: string;
             'x-component': import("react").MemoExoticComponent<(props: any) => import("react").JSX.Element>;
             'x-hidden': string;
+            'x-decorator': string;
             'x-reactions': {
                 dependencies: string[];
                 fulfill: {
@@ -109,6 +110,7 @@ export declare class ViewCollectionTemplate extends CollectionTemplate {
                     };
                 };
             };
+            description: string;
         };
         preview: {
             type: string;

package/es/data-source/collection-field/CollectionField.d.ts

@@ -7,9 +7,4 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 import React from 'react';
-/**
- * TODO: 初步适配
- * @internal
- */
-export declare const CollectionFieldInternalField: React.FC;
 export declare const CollectionField: React.ForwardRefExoticComponent<Omit<Partial<any>, "ref"> & React.RefAttributes<unknown>>;

package/es/data-source/data-block/DataBlockRequestProvider.d.ts

@@ -8,7 +8,10 @@
  */
 import React, { FC } from 'react';
 import { UseRequestResult } from '../../api-client';
-export declare const BlockRequestContext: React.Context<UseRequestResult<any>>;
+/**
+ * @internal
+ */
+export declare const BlockRequestLoadingContext: React.Context<boolean>;
 export declare function requestParentRecordData({ sourceId, association, parentRecord, api, headers, sourceKey, }: {
     sourceId?: number;
     association?: string;
@@ -17,7 +20,40 @@ export declare function requestParentRecordData({ sourceId, association, parentR
     headers?: any;
     sourceKey?: string;
 }): Promise<any>;
+export declare const BlockRequestContextProvider: FC<{
+    recordRequest: UseRequestResult<any>;
+}>;
 export declare const BlockRequestProvider: FC;
 export declare const useDataBlockRequest: <T extends {}>() => UseRequestResult<{
     data: T;
 }>;
+/**
+ * Compared to `useDataBlockRequest`, this Hook helps prevent unnecessary re-renders.
+ *
+ * This Hook returns a stable function reference that won't change between renders. When you only need
+ * methods like `refresh` or `run`, using this Hook is recommended because:
+ *
+ * 1. It returns a memoized object containing only the getter function
+ * 2. The getter function accesses the latest request data through a ref, avoiding re-renders
+ * 3. Unlike useDataBlockRequest which returns request state directly, this Hook provides indirect access
+ *    through a getter, breaking the reactive dependency chain
+ *
+ * For example:
+ * ```ts
+ * // This will re-render when request state changes
+ * const { refresh } = useDataBlockRequest();
+ *
+ * // This won't re-render when request state changes
+ * const { getDataBlockRequest } = useDataBlockRequestGetter();
+ * const refresh = getDataBlockRequest().refresh;
+ * ```
+ *
+ * @returns An object containing the getDataBlockRequest method that provides access to the request instance
+ */
+export declare const useDataBlockRequestGetter: () => {
+    getDataBlockRequest: () => UseRequestResult<any>;
+};
+/**
+ * When only data is needed, it's recommended to use this hook to avoid unnecessary re-renders
+ */
+export declare const useDataBlockRequestData: () => any;

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

@@ -15,3 +15,10 @@ export interface DataSourceManagerProviderProps {
 }
 export declare const DataSourceManagerProvider: FC<DataSourceManagerProviderProps>;
 export declare function useDataSourceManager(): DataSourceManager;
+/**
+ * 获取当前 collection 继承链路上的所有 collection
+ * @returns
+ */
+export declare function useAllCollectionsInheritChainGetter(): {
+    getAllCollectionsInheritChain: (collectionName: string, customDataSource?: string) => string[];
+};

package/es/document-title/index.d.ts

@@ -9,8 +9,8 @@
 import React from 'react';
 import { Plugin } from '../application/Plugin';
 interface DocumentTitleContextProps {
-    title?: any;
-    setTitle?: (title?: any) => void;
+    getTitle: () => string;
+    setTitle: (title?: any) => void;
 }
 export declare const DocumentTitleContext: React.Context<DocumentTitleContextProps>;
 export declare const DocumentTitleProvider: React.FC<{

package/es/filter-provider/FilterProvider.d.ts

@@ -6,9 +6,9 @@
  * 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 { CollectionFieldOptions_deprecated } from '../collection-manager';
 import { Collection } from '../data-source/collection/Collection';
+import React from 'react';
 declare enum FILTER_OPERATOR {
     AND = "$and",
     OR = "$or"
@@ -77,12 +77,9 @@ export declare const DataBlockCollector: ({ children, params, }: {
  * @returns
  */
 export declare const useFilterBlock: () => {
-    recordDataBlocks: (block: DataBlock) => void;
-    getDataBlocks: () => DataBlock[];
-    removeDataBlock: (uid: string) => void;
-    /**
-     * running in FilterBlockProvider
-     */
     inProvider: boolean;
+    recordDataBlocks: (...args: any[]) => void;
+    getDataBlocks: () => DataBlock[];
+    removeDataBlock: (...args: any[]) => void;
 };
 export {};

package/es/formily/NocoBaseField.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 { IFieldProps, JSXComponent, Schema } from '@formily/react';
+import React from 'react';
+/**
+ * To maintain high performance of Table, this component removes Formily-related components
+ * @param props component props
+ * @returns
+ */
+export declare const NocoBaseField: <D extends JSXComponent, C extends JSXComponent>(props: IFieldProps<D, C, import("@formily/core").Field<any, any, any, any>> & {
+    schema: Schema;
+}) => React.JSX.Element;

package/es/formily/NocoBaseReactiveField.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 { GeneralField } from '@formily/core';
+import { RenderPropsChildren } from '@formily/react';
+import React from 'react';
+interface IReactiveFieldProps {
+    field: GeneralField;
+    children?: RenderPropsChildren<GeneralField>;
+}
+/**
+ * Based on @formily/react v2.3.2 NocoBaseReactiveField component
+ * Modified to better adapt to NocoBase's needs
+ */
+export declare const NocoBaseReactiveField: React.FC<IReactiveFieldProps>;
+export {};

package/es/formily/NocoBaseRecursionField.d.ts

@@ -0,0 +1,58 @@
+/**
+ * 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 { IRecursionFieldProps, ISchema, ReactFC, Schema } from '@formily/react';
+import React, { FC } from 'react';
+import { CollectionFieldOptions } from '../data-source/collection/Collection';
+interface INocoBaseRecursionFieldProps extends IRecursionFieldProps {
+    /**
+     * Default Schema for collection fields
+     */
+    uiSchema?: ISchema;
+    /**
+     * Value for fields
+     */
+    values?: Record<string, any>;
+    /**
+     * @default true
+     * Whether to use Formily Field class - performance will be reduced but provides better compatibility with Formily
+     */
+    isUseFormilyField?: boolean;
+}
+export declare const RefreshComponentProvider: FC<{
+    refresh: () => void;
+}>;
+export declare const useRefreshComponent: () => () => void;
+/**
+ * Create a new fieldSchema instance to refresh the component after modifying fieldSchema
+ * @returns
+ */
+export declare const useRefreshFieldSchema: () => (options?: {
+    refreshParentSchema?: boolean;
+}) => void;
+/**
+ * @internal
+ * The difference from `useCollectionField` is that it returns empty if the current schema is not a collection field,
+ * while the value of `useCollectionField` is determined by the context in the component tree.
+ */
+export declare const useCollectionFieldUISchema: () => CollectionFieldOptions;
+export declare const CollectionFieldUISchemaProvider: FC<{
+    fieldSchema: Schema;
+}>;
+export declare const IsInNocoBaseRecursionFieldContext: React.Context<boolean>;
+/**
+ * @internal
+ * Note: Only suitable for use within the CollectionField component
+ */
+export declare const useIsInNocoBaseRecursionFieldContext: () => boolean;
+/**
+ * Based on @formily/react v2.3.2 RecursionField component
+ * Modified to better adapt to NocoBase's needs
+ */
+export declare const NocoBaseRecursionField: ReactFC<INocoBaseRecursionFieldProps>;
+export {};

package/es/formily/createNocoBaseField.d.ts

@@ -0,0 +1,61 @@
+/**
+ * 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 { IFieldProps } from '@formily/core';
+import { JSXComponent, Schema } from '@formily/react';
+export declare function createNocoBaseField<Decorator extends JSXComponent, Component extends JSXComponent>(props: any): NocoBaseField<any, any, any, any>;
+/**
+ * Compared to the Field class, NocoBaseField has better performance
+ */
+declare class NocoBaseField<Decorator extends JSXComponent = any, Component extends JSXComponent = any, TextType = any, ValueType = any> {
+    props: IFieldProps<Decorator, Component, TextType, ValueType> & {
+        schema: Schema;
+        compile: (source: any) => any;
+    };
+    initialized: boolean;
+    loading: boolean;
+    validating: boolean;
+    submitting: boolean;
+    selfModified: boolean;
+    active: boolean;
+    visited: boolean;
+    mounted: boolean;
+    unmounted: boolean;
+    inputValues: any[];
+    inputValue: any;
+    feedbacks: any[];
+    title: string;
+    description: string;
+    display: string;
+    pattern: string;
+    editable: boolean;
+    disabled: boolean;
+    readOnly: boolean;
+    readPretty: boolean;
+    visible: boolean;
+    hidden: boolean;
+    dataSource: any[];
+    validator: any;
+    required: boolean;
+    content: string;
+    initialValue: any;
+    value: any;
+    data: any;
+    decorator: any[];
+    component: any[];
+    decoratorProps: any;
+    componentProps: any;
+    decoratorType: any;
+    componentType: any;
+    path: any;
+    form: any;
+    address: any;
+    constructor(props: any);
+    protected initialize(): void;
+}
+export {};

package/es/hoc/withSkeletonComponent.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.
+ */
+import React from 'react';
+interface Options {
+    displayName?: string;
+    useLoading?: () => boolean;
+    SkeletonComponent?: React.ComponentType;
+    /**
+     * @default 300
+     * Delay time of skeleton component
+     */
+    delay?: number;
+}
+/**
+ * Display skeleton component while component is making API requests
+ * @param Component
+ * @param options
+ * @returns
+ */
+export declare const withSkeletonComponent: (Component: React.ComponentType<any>, options?: Options) => React.MemoExoticComponent<(props: any) => React.JSX.Element>;
+export {};

package/es/index.d.ts

@@ -35,6 +35,7 @@ export * from './global-theme';
 export * from './hooks';
 export * from './i18n';
 export * from './icon';
+export * from './lazy-helper';
 export { default as locale } from './locale';
 export * from './nocobase-buildin-plugin';
 export * from './plugin-manager';
@@ -53,6 +54,7 @@ export * from './testUtils';
 export * from './user';
 export * from './variables';
 export { withDynamicSchemaProps } from './hoc/withDynamicSchemaProps';
+export { withSkeletonComponent } from './hoc/withSkeletonComponent';
 export { SchemaSettingsActionLinkItem } from './modules/actions/link/customizeLinkActionSettings';
 export { useURLAndHTMLSchema } from './modules/actions/link/useURLAndHTMLSchema';
 export * from './modules/blocks/BlockSchemaToolbar';
@@ -68,3 +70,4 @@ export { SwitchLanguage } from './i18n/SwitchLanguage';
 export { VariablePopupRecordProvider } from './modules/variable/variablesProvider/VariablePopupRecordProvider';
 export { useCurrentPopupRecord } from './modules/variable/variablesProvider/VariablePopupRecordProvider';
 export { languageCodes } from './locale';
+export { CollectionFieldUISchemaProvider, IsInNocoBaseRecursionFieldContext, NocoBaseRecursionField, RefreshComponentProvider, useRefreshFieldSchema, } from './formily/NocoBaseRecursionField';