@nocobase/client-v2 2.1.0-alpha.40 → 2.1.0-alpha.45

package/es/layout-manager/LayoutContentRoute.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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 interface LayoutContentRouteProps {
+    layoutRouteName: string;
+}
+export declare const LayoutContentRoute: (props: LayoutContentRouteProps) => React.JSX.Element;
+export default LayoutContentRoute;

package/es/layout-manager/LayoutManager.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 { BaseApplication } from '../BaseApplication';
+import type { LayoutDefinition, LayoutRegisterOptions } from './types';
+export declare function normalizeLayoutRoutePath(routeName: string, routePath: string): string;
+export declare class LayoutManager<TApp extends BaseApplication<any> = BaseApplication<any>> {
+    private readonly app;
+    private readonly layouts;
+    private readonly uidIndex;
+    constructor(app: TApp);
+    registerLayout(options: LayoutRegisterOptions): LayoutDefinition;
+    getLayout(routeName: string): LayoutDefinition;
+    hasLayout(routeName: string): boolean;
+    listLayouts(): LayoutDefinition[];
+    private addStandardRoutes;
+}

package/es/layout-manager/LayoutRoute.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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 interface LayoutRouteProps {
+    layoutRouteName: string;
+}
+export declare const LayoutRoute: (props: LayoutRouteProps) => React.JSX.Element;
+export default LayoutRoute;

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

@@ -0,0 +1,13 @@
+/**
+ * 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 * from './LayoutManager';
+export * from './LayoutContentRoute';
+export * from './LayoutRoute';
+export * from './types';
+export * from './utils';

package/es/layout-manager/types.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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 interface LayoutRegisterOptions {
+    routeName: string;
+    routePath: string;
+    uid: string;
+    layoutModelClass: string;
+    rootPageModelClass?: string;
+    childPageModelClass?: string;
+    authCheck?: boolean;
+}
+export interface LayoutDefinition extends Required<LayoutRegisterOptions> {
+    rootRouteName: string;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * 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 function getLayoutPageRouteName(routeName: string): string;
+export declare function getLayoutPageTabRouteName(routeName: string): string;
+export declare function getLayoutPageViewRouteName(routeName: string): string;
+export declare function getLayoutPageTabViewRouteName(routeName: string): string;
+export declare function getLayoutContentRouteNames(routeName: string): string[];
+export declare function isLayoutContentRouteName(routeName: string, targetRouteName?: string): boolean;

package/es/nocobase-buildin-plugin/index.d.ts

@@ -22,22 +22,15 @@ export type CurrentRoleOption = {
 export declare const CurrentUserContext: React.Context<CurrentUserState>;
 export declare function useCurrentUserContext(): CurrentUserState;
 /**
- * 返回当前用户在 v2 应用上下文中可选的角色列表，等价于 v1 `useCurrentRoles`：
- * 从 FlowEngine 全局上下文 `engine.context.user.roles` 派生（CurrentUserProvider 在
- * `/auth:check` 成功后通过 `defineProperty('user', { value })` 写入），按需追加匿名角色，
- * 并去掉合并角色 `__union__`。v2 中角色 title 可能含有 `{{t('...')}}` 模板，因此用
- * flowEngine.context.t 解析。
+ * 返回当前用户在 v2 应用上下文中可选的角色列表，等价于 v1 `useCurrentRoles`：从 FlowEngine 全局上下文 `engine.context.user.roles` 派生（CurrentUserProvider 在 `/auth:check` 成功后通过 `defineProperty('user', { value })` 写入），按需追加匿名角色，并去掉合并角色 `__union__`。v2 中角色 title 可能含有 `{{t('...')}}` 模板，因此用 flowEngine.context.t 解析。
  *
- * 不读 React `CurrentUserContext`：FlowEngine 的 dialog/drawer/popover 内容通过 `ctx.viewer`
- * 渲染到独立的 ElementsHolder，部分场景会脱离原 Provider 树；FlowEngine 全局上下文是同一份
- * 数据但不受 React 树位置影响。
+ * 不读 React `CurrentUserContext`：FlowEngine 的 dialog/drawer/popover 内容通过 `ctx.viewer` 渲染到独立的 ElementsHolder，部分场景会脱离原 Provider 树；FlowEngine 全局上下文是同一份数据但不受 React 树位置影响。
  */
 export declare function useCurrentRoles(): CurrentRoleOption[];
 /**
  * client-v2 使用的内建插件集合。
  *
- * 只迁移当前 v2 运行时仍然需要的部分，显式跳过 schemaInitializerManager
- * 以及用户标注暂不迁移的旧插件注册逻辑。
+ * 只迁移当前 v2 运行时仍然需要的部分，显式跳过 schemaInitializerManager 以及用户标注暂不迁移的旧插件注册逻辑。
  */
 export declare class NocoBaseBuildInPlugin extends Plugin<any, Application> {
     afterAdd(): Promise<void>;

package/es/settings-center/index.d.ts

@@ -8,6 +8,6 @@
  */
 export * from './AdminSettingsLayout';
 export * from './AdminSettingsLayoutModel';
-export * from './PluginManagerPage';
+export * from './plugin-manager';
 export * from './SystemSettingsPage';
 export * from './utils';

package/es/settings-center/plugin-manager/BulkEnableButton.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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';
+import type { IPluginData } from './types';
+interface BulkEnableButtonProps {
+    plugins: IPluginData[];
+}
+export declare const BulkEnableButton: React.FC<BulkEnableButtonProps>;
+export {};

package/es/settings-center/plugin-manager/PluginCard.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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 { FC } from 'react';
+import type { IPluginData } from './types';
+interface PluginCardProps {
+    data: IPluginData;
+}
+export declare const PluginCard: FC<PluginCardProps>;
+export {};

package/es/settings-center/plugin-manager/PluginDetail.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 { FC } from 'react';
+import type { IPluginData } from './types';
+interface IPluginDetailProps {
+    plugin: IPluginData;
+    onCancel: () => void;
+}
+export declare const PluginDetail: FC<IPluginDetailProps>;
+export {};

package/es/settings-center/{PluginManagerPage.d.ts → plugin-manager/index.d.ts}

@@ -7,11 +7,5 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 import React from 'react';
-/**
- * `Plugin manager` 的最小只读页面。
- *
- * 首版只负责展示 `pm:list` 返回的插件列表和关键状态，
- * 不承载安装、升级、删除、启停等运维操作。
- */
-export declare const PluginManagerPage: () => React.JSX.Element;
+export declare const PluginManagerPage: React.FC;
 export default PluginManagerPage;

package/es/settings-center/plugin-manager/types.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 interface IPluginData {
+    id: number;
+    createdAt: Date;
+    updatedAt: Date;
+    name: string;
+    displayName: string;
+    packageName: string;
+    version: string;
+    enabled: boolean;
+    removable?: boolean;
+    installed: boolean;
+    builtIn: boolean;
+    registry?: string;
+    authToken?: string;
+    compressedFileUrl?: string;
+    options: Record<string, unknown>;
+    description?: string;
+    type: 'npm' | 'upload' | 'url';
+    isCompatible?: boolean;
+    readmeUrl: string;
+    changelogUrl: string;
+    error: boolean;
+    updatable?: boolean;
+    homepage?: string;
+    keywords?: string[];
+}