@nocobase/client 0.20.0-alpha.1 → 0.20.0-alpha.11

package/.dumirc.ts

@@ -179,12 +179,8 @@ export default defineConfig({
           title: 'DataBlock',
           type: 'group',
           children: [
-            // {
-            //   title: '临时',
-            //   link: '/core/data-block/tmp',
-            // },
             {
-              title: 'Record',
+              title: 'CollectionRecord',
               link: '/core/data-block/collection-record',
             },
             {

package/es/application/Application.d.ts

@@ -1,14 +1,14 @@
 import { APIClientOptions } from '@nocobase/sdk';
 import { i18n as i18next } from 'i18next';
 import React, { ComponentType, ReactElement } from 'react';
+import { APIClient } from '../api-client';
 import { PluginManager, PluginType } from './PluginManager';
 import { PluginSettingOptions, PluginSettingsManager } from './PluginSettingsManager';
 import { ComponentTypeAndString, RouterManager, RouterOptions } from './RouterManager';
 import { WebSocketClient, WebSocketClientOptions } from './WebSocketClient';
-import { APIClient } from '../api-client';
 import { SchemaInitializer, SchemaInitializerManager } from './schema-initializer';
 import { SchemaSettings, SchemaSettingsManager } from './schema-settings';
-import { type DataSourceManagerOptions, DataSourceManager } from '../data-source/data-source/DataSourceManager';
+import { DataSourceManager, type DataSourceManagerOptions } from '../data-source/data-source/DataSourceManager';
 import type { Plugin } from './Plugin';
 import type { RequireJS } from './utils/requirejs';
 declare global {
@@ -22,6 +22,7 @@ export type DevDynamicImport = (packageName: string) => Promise<{
 export type ComponentAndProps<T = any> = [ComponentType, T];
 export interface ApplicationOptions {
     name?: string;
+    publicPath?: string;
     apiClient?: APIClientOptions | APIClient;
     ws?: WebSocketClientOptions | boolean;
     i18n?: i18next;
@@ -66,6 +67,9 @@ export declare class Application {
     private addDefaultProviders;
     private addReactRouterComponents;
     private addRoutes;
+    getOptions(): ApplicationOptions;
+    getPublicPath(): string;
+    getRouteUrl(pathname: string): string;
     getCollectionManager(dataSource?: string): import("..").CollectionManager;
     getComposeProviders(): React.FC;
     use<T = any>(component: ComponentType, props?: T): number;

package/es/application/PluginSettingsManager.d.ts

@@ -37,6 +37,7 @@ export declare class PluginSettingsManager {
     protected settings: Record<string, PluginSettingOptions>;
     protected aclSnippets: string[];
     app: Application;
+    private cachedList;
     constructor(_pluginSettings: Record<string, PluginSettingOptions>, app: Application);
     setAclSnippets(aclSnippets: string[]): void;
     getAclSnippet(name: string): string;

package/es/application/RouterManager.d.ts

@@ -26,6 +26,7 @@ export declare class RouterManager {
     getRoutesTree(): RouteObject[];
     getRoutes(): Record<string, RouteType>;
     setType(type: RouterOptions['type']): void;
+    getBasename(): string;
     setBasename(basename: string): void;
     getRouterComponent(): React.FC<{
         BaseLayout?: ComponentType;

package/es/application/WebSocketClient.d.ts

@@ -1,9 +1,10 @@
-export declare const getWebSocketURL: () => string;
+import { Application } from './Application';
 export type WebSocketClientOptions = {
     reconnectInterval?: number;
     reconnectAttempts?: number;
     pingInterval?: number;
     url?: string;
+    basename?: string;
     protocols?: string | string[];
     onServerDown?: any;
 };
@@ -12,11 +13,13 @@ export declare class WebSocketClient {
     protected _reconnectTimes: number;
     protected events: any[];
     protected options: WebSocketClientOptions;
+    app: Application;
     enabled: boolean;
     connected: boolean;
     serverDown: boolean;
     lastMessage: {};
     constructor(options: WebSocketClientOptions | boolean);
+    getURL(): string;
     get reconnectAttempts(): number;
     get reconnectInterval(): number;
     get pingInterval(): number;

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

@@ -0,0 +1,27 @@
+import { SchemaInitializer } from './SchemaInitializer';
+/**
+ * @internal
+ *
+ * 因为需要把 SchemaInitializer 的 name 统一为一致的命名风格，统一之后新创建的 Schema 将
+ * 使用新的命名风格，而旧的 Schema 仍然使用旧的命名风格，这样会导致一些问题。所以需要有一个方法
+ * 可以确保旧版的 name 也可以正常工作，直到旧的 Schema 被移除。该类就是用来兼容旧 name 的：
+ *
+ * 1. 在新版实例中通过接收旧版 name 的实例，在新版实例变更后，同步变更旧版实例；
+ * 2. 在旧版实例中也接收新版 name 的实例，当旧版实例变更后，同步变更新版实例，这样可以保证在插件中即使不把旧版改成新版也能正常运行；
+ */
+export declare class CompatibleSchemaInitializer extends SchemaInitializer {
+    /**
+     * 需要同步变更的另一个实例
+     */
+    otherInstance: CompatibleSchemaInitializer;
+    constructor(options: any, otherInstance?: CompatibleSchemaInitializer);
+    add(name: string, item: any): void;
+    remove(nestedName: string): void;
+}
+/**
+ * 由于旧版的 schema 的 x-initializer 的值是旧的命名风格，当其与新的命名比较时就存在问题，
+ * 这里通过将新版命名转换为旧版命名再进行比较，已解决这个问题。
+ * @param oldOrNewName x-initializer 的值
+ * @param newName 新的命名
+ */
+export declare function isInitializersSame(oldOrNewName: string, newName: string): boolean;

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

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

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

@@ -4,4 +4,5 @@ export * from './types';
 export * from './context';
 export * from './components';
 export * from './SchemaInitializer';
+export * from './CompatibleSchemaInitializer';
 export * from './SchemaInitializerManager';

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

@@ -1,6 +1,9 @@
 import React from 'react';
 export declare const DetailsBlockContext: React.Context<any>;
 export declare const DetailsBlockProvider: (props: any) => React.JSX.Element;
+/**
+ * @deprecated
+ */
 export declare const useDetailsBlockContext: () => any;
 export declare const useDetailsBlockProps: () => {
     form: any;

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

@@ -1,6 +1,20 @@
 import { Schema } from '@formily/react';
 import React from 'react';
-export declare const FormBlockContext: React.Context<any>;
+import { CollectionRecord } from '../data-source';
+export declare const FormBlockContext: React.Context<{
+    [key: string]: any;
+    form?: any;
+    type?: 'update' | 'create';
+    action?: string;
+    field?: any;
+    service?: any;
+    resource?: any;
+    updateAssociationValues?: any;
+    formBlockRef?: any;
+    collectionName?: string;
+    params?: any;
+    formRecord?: CollectionRecord;
+}>;
 /**
  * 获取表单区块的类型：update 表示是表单编辑区块，create 表示是表单新增区块
  * @returns
@@ -10,7 +24,20 @@ export declare const useFormBlockType: () => {
 };
 export declare const useIsDetailBlock: () => boolean;
 export declare const FormBlockProvider: (props: any) => React.JSX.Element;
-export declare const useFormBlockContext: () => any;
+export declare const useFormBlockContext: () => {
+    [key: string]: any;
+    form?: any;
+    type?: 'update' | 'create';
+    action?: string;
+    field?: any;
+    service?: any;
+    resource?: any;
+    updateAssociationValues?: any;
+    formBlockRef?: any;
+    collectionName?: string;
+    params?: any;
+    formRecord?: CollectionRecord;
+};
 export declare const useFormBlockProps: () => {
     form: any;
 };

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

@@ -29,7 +29,7 @@ export declare const useSelfAndChildrenCollections: (collectionName: string) =>
     value: any;
     label: any;
 }[];
-export declare const useCollectionFilterOptions: (collection: any) => any[];
+export declare const useCollectionFilterOptions: (collection: any, dataSource?: string) => any[];
 export declare const useCollectionFilterOptionsV2: (collection: any) => {
     getFields: () => any[];
 };
@@ -77,6 +77,6 @@ export declare const useBulkDestroyActionAndRefreshCM: () => {
 };
 export declare const useFilterActionProps: () => {
     options: any;
-    onSubmit(values: any): void;
-    onReset(): void;
+    onSubmit(values: any): any;
+    onReset(): any;
 };

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

@@ -18,3 +18,4 @@ export * from './collectionPlugin';
 export * from './mixins/InheritanceCollectionMixin';
 export * from './sub-table';
 export * from './CollectionHistoryProvider';
+export * from './utils';

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

@@ -34,3 +34,6 @@ 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/interfaces/nanoid.d.ts

@@ -0,0 +1,69 @@
+import { CollectionFieldInterface } from '../../data-source/collection-field-interface/CollectionFieldInterface';
+export declare class NanoidFieldInterface extends CollectionFieldInterface {
+    name: string;
+    type: string;
+    group: string;
+    order: number;
+    title: string;
+    hidden: boolean;
+    sortable: boolean;
+    default: {
+        type: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+        };
+    };
+    availableTypes: string[];
+    properties: {
+        'uiSchema.title': {
+            type: string;
+            title: string;
+            required: boolean;
+            'x-decorator': string;
+            'x-component': string;
+        };
+        name: {
+            type: string;
+            title: string;
+            required: boolean;
+            'x-disabled': boolean;
+            'x-decorator': string;
+            'x-component': string;
+            description: string;
+        };
+        customAlphabet: {
+            type: string;
+            title: string;
+            default: string;
+            'x-decorator': string;
+            'x-component': string;
+        };
+        size: {
+            type: string;
+            title: string;
+            default: number;
+            'x-decorator': string;
+            'x-component': string;
+        };
+    };
+    filterable: {
+        operators: ({
+            label: string;
+            value: string;
+            selected: boolean;
+            noValue?: undefined;
+        } | {
+            label: string;
+            value: string;
+            selected?: undefined;
+            noValue?: undefined;
+        } | {
+            label: string;
+            value: string;
+            noValue: boolean;
+            selected?: undefined;
+        })[];
+    };
+    titleUsable: boolean;
+}

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

@@ -0,0 +1,71 @@
+import { CollectionFieldInterface } from '../../data-source/collection-field-interface/CollectionFieldInterface';
+export declare class UnixTimestampFieldInterface extends CollectionFieldInterface {
+    name: string;
+    type: string;
+    group: string;
+    order: number;
+    title: string;
+    sortable: boolean;
+    default: {
+        type: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+            'x-component-props': {
+                accuracy: string;
+                showTime: boolean;
+            };
+        };
+    };
+    availableTypes: string[];
+    hasDefaultValue: boolean;
+    properties: {
+        'uiSchema.x-component-props.accuracy': {
+            type: string;
+            title: string;
+            'x-component': string;
+            'x-decorator': string;
+            default: string;
+            enum: {
+                value: string;
+                label: string;
+            }[];
+        };
+        'uiSchema.title': {
+            type: string;
+            title: string;
+            required: boolean;
+            'x-decorator': string;
+            'x-component': string;
+        };
+        name: {
+            type: string;
+            title: string;
+            required: boolean;
+            'x-disabled': string;
+            'x-decorator': string;
+            'x-component': string;
+            'x-validator': string;
+            description: string;
+        };
+    };
+    filterable: {
+        operators: ({
+            label: string;
+            value: string;
+            selected: boolean;
+            noValue?: undefined;
+        } | {
+            label: string;
+            value: string;
+            selected?: undefined;
+            noValue?: undefined;
+        } | {
+            label: string;
+            value: string;
+            noValue: boolean;
+            selected?: undefined;
+        })[];
+    };
+    titleUsable: boolean;
+}

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

@@ -0,0 +1,56 @@
+import { CollectionFieldInterface } from '../../data-source/collection-field-interface/CollectionFieldInterface';
+export declare class UUIDFieldInterface extends CollectionFieldInterface {
+    name: string;
+    type: string;
+    group: string;
+    order: number;
+    title: string;
+    hidden: boolean;
+    sortable: boolean;
+    default: {
+        type: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+            'x-validator': string;
+        };
+    };
+    availableTypes: string[];
+    properties: {
+        'uiSchema.title': {
+            type: string;
+            title: string;
+            required: boolean;
+            'x-decorator': string;
+            'x-component': string;
+        };
+        name: {
+            type: string;
+            title: string;
+            required: boolean;
+            'x-disabled': boolean;
+            'x-decorator': string;
+            'x-component': string;
+            description: string;
+        };
+    };
+    filterable: {
+        operators: ({
+            label: string;
+            value: string;
+            selected: boolean;
+            noValue?: undefined;
+        } | {
+            label: string;
+            value: string;
+            selected?: undefined;
+            noValue?: undefined;
+        } | {
+            label: string;
+            value: string;
+            noValue: boolean;
+            selected?: undefined;
+        })[];
+    };
+    titleUsable: boolean;
+}

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

@@ -0,0 +1,2 @@
+export declare function parseCollectionName(collection: string): string[];
+export declare function joinCollectionName(dataSourceName: string, collectionName: string): string;

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

@@ -18,6 +18,7 @@ export interface AllDataBlockProps {
     parentRecord?: CollectionRecord;
     requestService?: UseRequestService<any>;
     requestOptions?: UseRequestOptions;
+    dataLoadingMode?: 'auto' | 'manual';
     [index: string]: any;
 }
 type CollectionCreateProps = Pick<AllDataBlockProps, 'collection' | 'dataSource'>;

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

@@ -26,12 +26,15 @@ export declare class DataSourceManager {
     collectionFieldInterfaceManager: CollectionFieldInterfaceManager;
     constructor(options: DataSourceManagerOptions, app: Application);
     addCollectionMixins(mixins?: (typeof Collection)[]): void;
-    getDataSources(): DataSource[];
+    getDataSources(filterCollection?: (dataSource: DataSource) => boolean): DataSource[];
     getDataSource(key?: string): DataSource;
     removeDataSources(keys: string[]): void;
     addDataSource(DataSource: DataSourceFactory, options: DataSourceOptions): DataSource;
     addDataSources(request: () => Promise<DataSourceOptions[]>, DataSource: DataSourceFactory): Promise<void>;
-    getAllCollections(predicate?: (collection: Collection) => boolean): (DataSourceOptions & {
+    getAllCollections(options?: {
+        filterCollection?: (collection: Collection) => boolean;
+        filterDataSource?: (dataSource: DataSource) => boolean;
+    }): (DataSourceOptions & {
         collections: Collection[];
     })[];
     addFieldInterfaceGroups(options: Record<string, {

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

@@ -29,6 +29,8 @@ export interface DataBlock {
     doFilter: (params: any, params2?: any) => Promise<void>;
     /** 清除筛选区块设置的筛选参数 */
     clearFilter: (uid: string) => void;
+    /** 将数据区块的数据置为空 */
+    clearData: () => void;
     /** 数据区块表中所有的关系字段 */
     associatedFields?: CollectionFieldOptions_deprecated[];
     /** 数据区块表中所有的外键字段 */
@@ -39,6 +41,11 @@ export interface DataBlock {
     service?: any;
     /** 数据区块所的 DOM 容器 */
     dom: HTMLElement;
+    /**
+     * auto: 数据区块会在初始渲染时请求数据
+     * manual: 只有当点击了筛选按钮，才会请求数据
+     */
+    dataLoadingMode?: 'auto' | 'manual';
 }
 /**
  * 主要用于记录当前页面中的数据区块的信息，用于在过滤区块中使用

package/es/index.d.ts

@@ -51,3 +51,4 @@ export * from './modules/blocks/BlockSchemaToolbar';
 export * from './modules/blocks/data-blocks/table';
 export * from './modules/blocks/data-blocks/form';
 export * from './modules/blocks/data-blocks/table-selector';
+export * from './modules/blocks/data-blocks/details-multi/setDataLoadingModeSettingsItem';