@nocobase/client 0.14.0-alpha.7 → 0.15.0-alpha.1

package/.dumirc.ts

@@ -1,18 +1,6 @@
-import { defineConfig } from 'dumi';
-import { defineThemeConfig } from 'dumi-theme-nocobase'
 import { getUmiConfig } from '@nocobase/devtools/umiConfig';
-import fs from 'fs';
-import path from 'path';
-
-const contributingPath = path.resolve(__dirname, './contributing.md');
-const docsContributingPath = path.resolve(__dirname, './docs/contributing.md');
-
-// check if the target path already exists, and remove it if it does
-if (fs.existsSync(docsContributingPath)) {
-  fs.unlinkSync(docsContributingPath);
-}
-
-fs.copyFileSync(contributingPath, docsContributingPath);
+import { defineConfig } from 'dumi';
+import { defineThemeConfig } from 'dumi-theme-nocobase';
 
 const umiConfig = getUmiConfig();
 
@@ -23,34 +11,106 @@ export default defineConfig({
   },
   resolve: {
     atomDirs: [
-      { type: 'component', dir: 'src' },
-      { type: 'component', dir: 'src/schema-component/antd' },
-      { type: 'component', dir: 'src/route-switch/antd' },
-    ]
+      { type: 'api', dir: 'src' },
+      { type: 'api', dir: 'src/schema-component/antd' },
+      { type: 'api', dir: 'src/route-switch/antd' },
+    ],
   },
   themeConfig: defineThemeConfig({
     title: 'NocoBase',
     logo: 'https://www.nocobase.com/images/logo.png',
     github: 'https://github.com/nocobase/nocobase',
     footer: 'nocobase | Copyright © 2022',
-    sidebarGroupModePath: ['/components'],
+    // sidebarGroupModePath: ['/components'],
     nav: [
       {
-        title: 'Intro',
-        link: '/intro',
+        title: 'API',
+        link: '/apis/application',
       },
-      {
-        title: 'Client',
-        link: '/components/acl',
-      },
-      {
-        title: 'Develop',
-        link: '/develop',
-      },
-      {
-        title: 'Contributing',
-        link: '/contributing',
-      }
-    ]
-  })
+    ],
+    sidebarEnhance: {
+      '/apis': [
+        {
+          title: 'Core',
+          type: 'group',
+          children: [
+            {
+              title: 'Application',
+              children: [
+                {
+                  title: 'Application',
+                  link: '/apis/application',
+                },
+                {
+                  title: 'APIClient',
+                  link: '/apis/api-client',
+                },
+                {
+                  title: 'PluginSettingsManager',
+                  link: '#',
+                },
+              ],
+            },
+            {
+              title: 'UI schema designer',
+              children: [
+                {
+                  title: 'SchemaComponent',
+                  link: '#',
+                },
+                {
+                  title: 'SchemaInitializer',
+                  link: '#',
+                },
+                {
+                  title: 'SchemaSettings',
+                  link: '#',
+                },
+                {
+                  title: 'DNDContext & DragHandler',
+                  link: '#',
+                },
+              ],
+            },
+            {
+              title: 'Collection Manager',
+              link: '#',
+            },
+            {
+              title: 'BlockProvider',
+              link: '#',
+            },
+            {
+              title: 'RecordProvider',
+              link: '#',
+            },
+          ],
+        },
+        {
+          title: 'React components',
+          type: 'group',
+          children: [
+            {
+              title: 'Board',
+              link: '#',
+            },
+            {
+              title: 'Icon',
+              link: '#',
+            },
+          ],
+        },
+        {
+          title: 'Schema components',
+          type: 'group',
+          children: [
+            {
+              title: 'Input',
+              link: '#',
+            },
+          ],
+        },
+      ],
+    },
+  }),
 });

package/docs/index.md

@@ -0,0 +1 @@
+<Navigate replace to="/apis/application"></Navigate>

package/es/application/Application.d.ts

@@ -1,12 +1,13 @@
 import { APIClientOptions } from '@nocobase/sdk';
 import { i18n as i18next } from 'i18next';
 import React, { ComponentType, ReactElement } from 'react';
-import { APIClient } from '../api-client';
-import type { Plugin } from './Plugin';
 import { PluginManager, PluginType } from './PluginManager';
 import { ComponentTypeAndString, RouterManager, RouterOptions } from './RouterManager';
 import { WebSocketClient, WebSocketClientOptions } from './WebSocketClient';
+import { PluginSettingsManager } from './PluginSettingsManager';
+import { APIClient } from '../api-client';
 import type { RequireJS } from './utils/requirejs';
+import type { Plugin } from './Plugin';
 declare global {
     interface Window {
         define: RequireJS['define'];
@@ -26,6 +27,7 @@ export interface ApplicationOptions {
     scopes?: Record<string, any>;
     router?: RouterOptions;
     devDynamicImport?: DevDynamicImport;
+    loadRemotePlugins?: boolean;
 }
 export declare class Application {
     protected options: ApplicationOptions;
@@ -37,6 +39,7 @@ export declare class Application {
     apiClient: APIClient;
     components: Record<string, ComponentType>;
     pm: PluginManager;
+    pluginSettingsManager: PluginSettingsManager;
     devDynamicImport: DevDynamicImport;
     requirejs: RequireJS;
     notification: any;
@@ -44,10 +47,12 @@ export declare class Application {
     maintained: boolean;
     maintaining: boolean;
     error: any;
+    get pluginManager(): PluginManager;
     constructor(options?: ApplicationOptions);
     private initRequireJs;
     private addDefaultProviders;
     private addReactRouterComponents;
+    private addRoutes;
     getComposeProviders(): React.FC;
     use<T = any>(component: ComponentType, props?: T): number;
     addProvider<T = any>(component: ComponentType, props?: T): number;

package/es/application/PluginManager.d.ts

@@ -14,11 +14,12 @@ export type PluginData = {
 };
 export declare class PluginManager {
     protected _plugins: PluginType[];
+    protected loadRemotePlugins: boolean;
     protected app: Application;
     protected pluginInstances: Map<typeof Plugin, Plugin>;
     protected pluginsAliases: Record<string, Plugin>;
     private initPlugins;
-    constructor(_plugins: PluginType[], app: Application);
+    constructor(_plugins: PluginType[], loadRemotePlugins: boolean, app: Application);
     init(_plugins: PluginType[]): Promise<void>;
     private initStaticPlugins;
     private initRemotePlugins;

package/es/application/PluginSettingsManager.d.ts

@@ -0,0 +1,49 @@
+import type { Application } from './Application';
+import type { RouteType } from './RouterManager';
+export declare const ADMIN_SETTINGS_KEY = "admin.settings.";
+export declare const ADMIN_SETTINGS_PATH = "/admin/settings/";
+export declare const SNIPPET_PREFIX = "pm.";
+export interface PluginSettingsManagerSettingOptionsType {
+    title: string;
+    Component: RouteType['Component'];
+    icon?: string;
+    /**
+     * sort, the smaller the number, the higher the priority
+     * @default 0
+     */
+    sort?: number;
+    isBookmark?: boolean;
+    aclSnippet?: string;
+    [index: string]: any;
+}
+export interface PluginSettingsPageType {
+    label?: string;
+    title: string;
+    key: string;
+    icon: any;
+    path: string;
+    sort?: number;
+    name?: string;
+    pluginName?: string;
+    isBookmark?: boolean;
+    children?: PluginSettingsPageType[];
+    [index: string]: any;
+}
+export declare class PluginSettingsManager {
+    protected app: Application;
+    protected settings: Record<string, PluginSettingsManagerSettingOptionsType>;
+    protected aclSnippets: string[];
+    constructor(app: Application);
+    setAclSnippets(aclSnippets: string[]): void;
+    getAclSnippet(name: string): string;
+    getRouteName(name: string): string;
+    getRoutePath(name: string): string;
+    add(name: string, options: PluginSettingsManagerSettingOptionsType): void;
+    remove(name: string): void;
+    hasAuth(name: string): boolean;
+    getSetting(name: string): PluginSettingsManagerSettingOptionsType;
+    has(name: string): boolean;
+    get(name: string, filterAuth?: boolean): PluginSettingsPageType;
+    getList(filterAuth?: boolean): PluginSettingsPageType[];
+    getAclSnippets(): string[];
+}

package/es/application/components/defaultComponents.d.ts

@@ -5,4 +5,5 @@ export declare const defaultAppComponents: {
     AppError: React.FC<{
         error: Error;
     }>;
+    AppNotFound: React.FC;
 };

package/es/application/index.d.ts

@@ -3,3 +3,4 @@ export * from './hooks';
 export * from './Plugin';
 export * from './RouterManager';
 export * from './utils';
+export * from './PluginSettingsManager';

package/es/application/utils/remotePlugins.d.ts

@@ -4,11 +4,11 @@ import type { RequireJS } from './requirejs';
 import type { DevDynamicImport } from '../Application';
 export declare function defineDevPlugins(plugins: Record<string, typeof Plugin>): void;
 export declare function definePluginClient(packageName: string): void;
-export declare function getRemotePlugins(requirejs: any, pluginData?: PluginData[]): Promise<Array<typeof Plugin>>;
+export declare function getRemotePlugins(requirejs: any, pluginData?: PluginData[]): Promise<Array<[string, typeof Plugin]>>;
 interface GetPluginsOption {
     requirejs: RequireJS;
     pluginData: PluginData[];
     devDynamicImport?: DevDynamicImport;
 }
-export declare function getPlugins(options: GetPluginsOption): Promise<Array<typeof Plugin>>;
+export declare function getPlugins(options: GetPluginsOption): Promise<Array<[string, typeof Plugin]>>;
 export {};

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

@@ -27,7 +27,18 @@ export declare const useBlockRequestContext: () => {
     updateAssociationValues?: any[];
 };
 export declare const RenderChildrenWithAssociationFilter: React.FC<any>;
-export declare const BlockProvider: (props: any) => React.JSX.Element;
+export declare const useBlockContext: () => {
+    /** 用以区分区块的标识 */
+    name: string;
+};
+export declare const BlockProvider: (props: {
+    name: string;
+    resource: any;
+    collection?: any;
+    association?: any;
+    params?: any;
+    children?: any;
+}) => React.JSX.Element;
 export declare const useBlockAssociationContext: () => any;
 export declare const useFilterByTk: () => any;
 export declare const useSourceIdFromRecord: () => any;

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

@@ -1,7 +1,14 @@
 import { Schema } from '@formily/react';
 import React from 'react';
 export declare const FormBlockContext: React.Context<any>;
-export declare const useIsEmptyRecord: () => boolean;
+/**
+ * 获取表单区块的类型：update 表示是表单编辑区块，create 表示是表单新增区块
+ * @returns
+ */
+export declare const useFormBlockType: () => {
+    type: 'update' | 'create';
+};
+export declare const useIsDetailBlock: () => boolean;
 export declare const FormBlockProvider: (props: any) => React.JSX.Element;
 export declare const useFormBlockContext: () => any;
 export declare const useFormBlockProps: () => {

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

@@ -9,6 +9,7 @@ type Params = {
 export declare const TableSelectorContext: React.Context<any>;
 type TableSelectorProviderProps = {
     params: Record<string, any>;
+    resource: any;
     collection?: string;
     dragSort?: boolean;
     children?: any;

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

@@ -0,0 +1,7 @@
+import React from 'react';
+export declare const useTemplateBlockContext: () => {
+    templateFinshed?: boolean;
+    onTemplateSuccess?: Function;
+};
+declare const TemplateBlockProvider: (props: any) => React.JSX.Element;
+export { TemplateBlockProvider };

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

@@ -1,8 +1,18 @@
 import { ChangeEvent } from 'react';
 export * from './useFormActiveFields';
+export * from './useParsedFilter';
 export declare const usePickActionProps: () => {
     onClick(): void;
 };
+export declare function getFormValues({ filterByTk, field, form, fieldNames, getField, resource, actionFields, }: {
+    filterByTk: any;
+    field: any;
+    form: any;
+    fieldNames: any;
+    getField: any;
+    resource: any;
+    actionFields: any[];
+}): any;
 export declare const useCreateActionProps: () => {
     onClick(): Promise<void>;
 };

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

@@ -9,6 +9,11 @@ interface FormActiveFieldsProviderValue {
 interface ProviderProps extends Partial<FormActiveFieldsProviderValue> {
     children: React.ReactNode;
 }
+/**
+ * 用于提供获取和更新当前表单区块中已显示出来的字段
+ * @param param0
+ * @returns
+ */
 export declare const FormActiveFieldsProvider: ({ children, name, getActiveFieldsName, addActiveFieldName, removeActiveFieldName, }: ProviderProps) => React.JSX.Element;
 /**
  * 用于获取和更新当前表单区块中已显示出来的字段

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

@@ -0,0 +1,6 @@
+export declare function useParsedFilter({ filterOption, currentRecord }: {
+    filterOption: any;
+    currentRecord?: any;
+}): {
+    filter: {};
+};

package/es/collection-manager/Configuration/DeleteCollectionAction.d.ts

@@ -0,0 +1,18 @@
+import React from 'react';
+export declare const DeleteCollection: (props: any) => React.JSX.Element;
+export declare const useDestroyActionAndRefreshCM: () => {
+    run(): Promise<void>;
+};
+export declare const useBulkDestroyActionAndRefreshCM: () => {
+    run(): Promise<void>;
+};
+export declare const useDestroyAction: () => {
+    run(): Promise<void>;
+};
+export declare const useBulkDestroyAction: () => {
+    run(): Promise<boolean>;
+};
+export declare const DeleteCollectionAction: {
+    (props: any): React.JSX.Element;
+    displayName: string;
+};

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

@@ -14,3 +14,4 @@ export * from './AddCategoryAction';
 export * from './EditCategoryAction';
 export * from './SyncFieldsAction';
 export * from './SyncSQLFieldsAction';
+export * from './DeleteCollectionAction';

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

@@ -43,6 +43,9 @@ export declare const useSelfAndChildrenCollections: (collectionName: string) =>
     label: any;
 }[];
 export declare const useCollectionFilterOptions: (collection: any) => any[];
+export declare const useCollectionFilterOptionsV2: (collection: any) => {
+    getFields: () => any[];
+};
 export declare const useLinkageCollectionFilterOptions: (collectionName: string) => any[];
 export declare const useCollectionFieldsOptions: (collectionName: string, maxDepth?: number, excludes?: any[]) => any[];
 export declare const useFilterDataSource: (options: any) => {

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

@@ -40,6 +40,11 @@ export interface DataBlock {
  * @returns
  */
 export declare const FilterBlockProvider: React.FC;
+/**
+ * 用于收集记录当前页面中的数据区块的信息
+ * @param param0
+ * @returns
+ */
 export declare const FilterBlockRecord: ({ children, params, }: {
     children: React.ReactNode;
     params?: {

package/es/flag-provider/FlagProvider.d.ts

@@ -12,6 +12,14 @@ export interface FlagProviderProps {
      * 是否存在于 `表单数据模板` 中
      */
     isInFormDataTemplate?: boolean;
+    /**
+     * 是否存在于 `子表格` 中
+     */
+    isInSubTable?: boolean;
+    /**
+     * 是否存在于 `子表单` 中
+     */
+    isInSubForm?: boolean;
     children: any;
 }
 export declare const FlagContext: React.Context<Omit<FlagProviderProps, "children">>;