@nocobase/client 1.6.0-alpha.2 → 1.6.0-alpha.20

package/es/api-client/APIClient.d.ts

@@ -20,6 +20,7 @@ export declare class APIClient extends APIClientSDK {
     service(uid: string): Result<any, any>;
     interceptors(): void;
     toErrMessages(error: any): any;
+    handleNotificationError(error: any): Promise<any>;
     useNotificationMiddleware(): void;
     silent(): APIClient;
 }

package/es/appInfo/CurrentAppInfoProvider.d.ts

@@ -16,6 +16,7 @@ export declare const useCurrentAppInfo: () => {
         lang: string;
         version: string;
         exportLimit?: number;
+        name: string;
     };
 };
 export declare const CurrentAppInfoProvider: (props: any) => React.JSX.Element;

package/es/application/Application.d.ts

@@ -52,6 +52,7 @@ export interface ApplicationOptions {
 }
 export declare class Application {
     protected options: ApplicationOptions;
+    eventBus: EventTarget;
     providers: ComponentAndProps[];
     router: RouterManager;
     scopes: Record<string, any>;
@@ -68,13 +69,24 @@ export declare class Application {
     schemaSettingsManager: SchemaSettingsManager;
     dataSourceManager: DataSourceManager;
     name: string;
+    globalVars: Record<string, any>;
     loading: boolean;
     maintained: boolean;
     maintaining: boolean;
     error: any;
+    hasLoadError: boolean;
+    private wsAuthorized;
     get pm(): PluginManager;
     get disableAcl(): boolean;
+    get isWsAuthorized(): boolean;
+    setWsAuthorized(authorized: boolean): void;
     constructor(options?: ApplicationOptions);
+    private initListeners;
+    protected setTokenInWebSocket(options: {
+        token: string;
+        authenticator: string;
+    }): void;
+    setMaintaining(maintaining: boolean): void;
     private initRequireJs;
     private addDefaultProviders;
     private addReactRouterComponents;
@@ -84,6 +96,7 @@ export declare class Application {
     getPublicPath(): string;
     getApiUrl(pathname?: string): string;
     getRouteUrl(pathname: string): string;
+    getHref(pathname: string): string;
     getCollectionManager(dataSource?: string): import("../data-source").CollectionManager;
     /**
      * @internal
@@ -93,6 +106,7 @@ export declare class Application {
     addProvider<T = any>(component: ComponentType, props?: T): number;
     addProviders(providers: (ComponentType | [ComponentType, any])[]): void;
     load(): Promise<void>;
+    loadWebSocket(): Promise<void>;
     getComponent<T = any>(Component: ComponentTypeAndString<T>, isShowError?: boolean): ComponentType<T> | undefined;
     renderComponent<T extends {}>(Component: ComponentTypeAndString, props?: T, children?: ReactNode): ReactElement;
     /**
@@ -107,4 +121,6 @@ export declare class Application {
     mount(containerOrSelector: Element | ShadowRoot | string): any;
     addFieldInterfaces(fieldInterfaceClasses?: CollectionFieldInterfaceFactory[]): void;
     addFieldInterfaceComponentOption(fieldName: string, componentOption: CollectionFieldInterfaceComponentOption): void;
+    addGlobalVar(key: string, value: any): void;
+    getGlobalVar(key: any): any;
 }

package/es/application/RouterManager.d.ts

@@ -31,6 +31,10 @@ export declare class RouterManager {
     protected routes: Record<string, RouteType>;
     protected options: RouterOptions;
     app: Application;
+    private router;
+    get basename(): any;
+    get state(): any;
+    get navigate(): any;
     constructor(options: RouterOptions, app: Application);
     /**
      * @internal

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

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

package/es/application/hooks/useGlobalVariable.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 declare const useGlobalVariable: (key: string) => any;

package/es/application/schema-settings/utils/createSwitchSettingsItem.d.ts

@@ -15,6 +15,7 @@ export interface CreateSwitchSchemaSettingsItemProps {
     defaultValue?: boolean;
     useDefaultValue?: () => boolean;
     useVisible?: () => boolean;
+    useComponentProps?: () => any;
     /**
      * @default 'common'
      */

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

@@ -102,7 +102,7 @@ export declare const BlockProvider: (props: {
  * @returns
  */
 export declare const useBlockAssociationContext: () => any;
-export declare const useFilterByTk: () => any;
+export declare const useFilterByTk: (blockProps?: any) => any;
 /**
  * @deprecated
  */
@@ -116,7 +116,7 @@ export declare const useSourceIdFromParentRecord: () => any;
  * @internal
  * @returns
  */
-export declare const useParamsFromRecord: () => {
+export declare const useParamsFromRecord: (props?: any) => {
     filterByTk: any;
 };
 export declare const RecordLink: (props: any) => React.JSX.Element;

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

@@ -153,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/interfaces/checkbox.d.ts

@@ -48,10 +48,30 @@ export declare class CheckboxFieldInterface extends CollectionFieldInterface {
             value: string;
             selected: boolean;
             noValue: boolean;
+            schema: {
+                'x-component': string;
+                'x-component-props': {
+                    multiple: boolean;
+                    options: {
+                        label: string;
+                        value: boolean;
+                    }[];
+                };
+            };
         } | {
             label: string;
             value: string;
             noValue: boolean;
+            schema: {
+                'x-component': string;
+                'x-component-props': {
+                    multiple: boolean;
+                    options: {
+                        label: string;
+                        value: boolean;
+                    }[];
+                };
+            };
             selected?: undefined;
         })[];
     };

package/es/collection-manager/interfaces/properties/operators.d.ts

@@ -184,10 +184,30 @@ export declare const boolean: ({
     value: string;
     selected: boolean;
     noValue: boolean;
+    schema: {
+        'x-component': string;
+        'x-component-props': {
+            multiple: boolean;
+            options: {
+                label: string;
+                value: boolean;
+            }[];
+        };
+    };
 } | {
     label: string;
     value: string;
     noValue: boolean;
+    schema: {
+        'x-component': string;
+        'x-component-props': {
+            multiple: boolean;
+            options: {
+                label: string;
+                value: boolean;
+            }[];
+        };
+    };
     selected?: undefined;
 })[];
 export declare const tableoid: {

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

@@ -17,17 +17,6 @@ export declare class SqlCollectionTemplate extends CollectionTemplate {
         fields: any[];
     };
     configurableProperties: {
-        filterTargetKey: {
-            title: string;
-            type: string;
-            description: string;
-            'x-decorator': string;
-            'x-component': string;
-            'x-component-props': {
-                multiple: boolean;
-            };
-            'x-reactions': string[];
-        };
         name: any;
         title: any;
         description: any;
@@ -84,5 +73,16 @@ export declare class SqlCollectionTemplate extends CollectionTemplate {
                 };
             };
         };
+        filterTargetKey: {
+            title: string;
+            type: string;
+            description: string;
+            'x-decorator': string;
+            'x-component': string;
+            'x-component-props': {
+                multiple: boolean;
+            };
+            'x-reactions': string[];
+        };
     };
 }

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

@@ -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/data-block/DataBlockRequestProvider.d.ts

@@ -28,10 +28,27 @@ export declare const useDataBlockRequest: <T extends {}>() => UseRequestResult<{
     data: T;
 }>;
 /**
- * Compared to `useDataBlockRequest`, the advantage of this hook is that it prevents unnecessary re-renders.
- * For example, if you only need to use methods like `refresh` or `run`, it's recommended to use this hook,
- * as it avoids component re-rendering when re-triggering requests.
- * @returns
+ * 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>;

package/es/formily/NocoBaseField.d.ts

@@ -8,6 +8,11 @@
  */
 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

@@ -17,7 +17,5 @@ interface IReactiveFieldProps {
  * Based on @formily/react v2.3.2 NocoBaseReactiveField component
  * Modified to better adapt to NocoBase's needs
  */
-export declare const NocoBaseReactiveField: React.MemoExoticComponent<import("@formily/react").ReactFC<IReactiveFieldProps & {
-    ref?: React.RefAttributes<any>;
-}>>;
+export declare const NocoBaseReactiveField: React.FC<IReactiveFieldProps>;
 export {};

package/es/formily/NocoBaseRecursionField.d.ts

@@ -24,12 +24,16 @@ interface INocoBaseRecursionFieldProps extends IRecursionFieldProps {
      */
     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?: {
-    refreshParent?: boolean;
+    refreshParentSchema?: boolean;
 }) => void;
 /**
  * @internal

package/es/formily/createNocoBaseField.d.ts

@@ -6,9 +6,56 @@
  * 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 { IFieldFactoryProps } from '@formily/core';
-import { Field } from '@formily/core/esm/models/Field';
-import { JSXComponent } from '@formily/react';
-export declare function createNocoBaseField<Decorator extends JSXComponent, Component extends JSXComponent>(props: IFieldFactoryProps<Decorator, Component> & {
-    compile: (source: any) => any;
-}): Field<Decorator, Component>;
+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/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';
@@ -52,22 +53,25 @@ export * from './system-settings';
 export * from './testUtils';
 export * from './user';
 export * from './variables';
-export * from './lazy-helper';
 export { withDynamicSchemaProps } from './hoc/withDynamicSchemaProps';
 export { withSkeletonComponent } from './hoc/withSkeletonComponent';
+export { SwitchLanguage } from './i18n/SwitchLanguage';
 export { SchemaSettingsActionLinkItem } from './modules/actions/link/customizeLinkActionSettings';
-export { useURLAndHTMLSchema } from './modules/actions/link/useURLAndHTMLSchema';
+export { getVariableComponentWithScope, useURLAndHTMLSchema } from './modules/actions/link/useURLAndHTMLSchema';
 export * from './modules/blocks/BlockSchemaToolbar';
 export * from './modules/blocks/data-blocks/form';
 export * from './modules/blocks/data-blocks/table';
 export * from './modules/blocks/data-blocks/table-selector';
 export * from './modules/blocks/index';
 export * from './modules/blocks/useParentRecordCommon';
+export { getGroupMenuSchema } from './modules/menu/GroupItem';
+export { getLinkMenuSchema } from './modules/menu/LinkMenuItem';
+export { getPageMenuSchema } from './modules/menu/PageMenuItem';
 export { OpenModeProvider, useOpenModeContext } from './modules/popup/OpenModeProvider';
 export { PopupContextProvider } from './modules/popup/PopupContextProvider';
 export { usePopupUtils } from './modules/popup/usePopupUtils';
-export { SwitchLanguage } from './i18n/SwitchLanguage';
 export { VariablePopupRecordProvider } from './modules/variable/variablesProvider/VariablePopupRecordProvider';
 export { useCurrentPopupRecord } from './modules/variable/variablesProvider/VariablePopupRecordProvider';
+export { showFileName } from './modules/fields/component/FileManager/fileManagerComponentFieldSettings';
 export { languageCodes } from './locale';
-export { NocoBaseRecursionField, CollectionFieldUISchemaProvider, IsInNocoBaseRecursionFieldContext, } from './formily/NocoBaseRecursionField';
+export { CollectionFieldUISchemaProvider, IsInNocoBaseRecursionFieldContext, NocoBaseRecursionField, RefreshComponentProvider, useRefreshFieldSchema, } from './formily/NocoBaseRecursionField';