@nocobase/client-v2 2.1.0-beta.9 → 2.2.0-beta.1

package/es/APIClient.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 { APIClient as APIClientSDK, type APIClientOptions } from '@nocobase/sdk';
+export declare class APIClient extends APIClientSDK {
+    appName?: string;
+    constructor(options?: APIClientOptions);
+    getHostname(): string;
+    getHeaders(): {};
+    interceptors(): void;
+}

package/es/Application.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 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 APIClientOptions } from '@nocobase/sdk';
+import { type i18n as i18next } from 'i18next';
+import { APIClient } from './APIClient';
+import { BaseApplication, type BaseApplicationOptions } from './BaseApplication';
+import type { PluginType } from './PluginManager';
+import { PluginManager } from './PluginManager';
+import { PluginSettingsManager } from './PluginSettingsManager';
+import type { RouterOptions } from './RouterManager';
+import { RouterManager } from './RouterManager';
+import type { WebSocketClientOptions } from './WebSocketClient';
+export type { DevDynamicImport, ComponentAndProps } from './BaseApplication';
+export { ApplicationModel } from './BaseApplication';
+export interface ApplicationOptions extends BaseApplicationOptions<PluginType> {
+    apiClient?: APIClientOptions;
+    ws?: WebSocketClientOptions | boolean;
+    i18n?: i18next;
+    plugins?: PluginType[];
+    components?: BaseApplicationOptions<PluginType>['components'];
+    router?: RouterOptions;
+}
+export declare class Application extends BaseApplication<ApplicationOptions, PluginManager, RouterManager, APIClient, PluginSettingsManager> {
+    dataSourceManager: any;
+    hasLoadError: boolean;
+    protected createApiClient(options: ApplicationOptions): APIClient;
+    protected configureRuntimeAdapters(): void;
+    protected createI18n(options: ApplicationOptions): i18next;
+    protected createRouterManager(options: ApplicationOptions): RouterManager<this>;
+    protected createPluginManager(options: ApplicationOptions): PluginManager;
+    protected createPluginSettingsManager(_options: ApplicationOptions): PluginSettingsManager;
+    load(): Promise<void>;
+    loadWebSocket(): Promise<void>;
+    protected addCustomProviders(): void;
+    addFieldInterfaces(fieldInterfaceClasses?: any[]): any;
+    addFieldInterfaceGroups(groups: Record<string, {
+        label: string;
+        order?: number;
+    }>): any;
+    addFieldInterfaceComponentOption(fieldName: string, componentOption: any): any;
+    addFieldInterfaceOperator(name: string, operatorOption: any): any;
+    registerFieldFilterOperator(operator: any): any;
+    registerFieldFilterOperatorGroup(name: string, operators?: any[]): any;
+    addFieldFilterOperatorsToGroup(name: string, operators?: any[]): any;
+    registerFieldValidationConfigure(item: any): any;
+    registerFieldValidationConfigureGroup(name: string, items?: any[]): any;
+    addFieldValidationConfiguresToGroup(name: string, items?: any[]): any;
+}

package/es/BaseApplication.d.ts

@@ -0,0 +1,197 @@
+/**
+ * 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 { FlowEngine, FlowEngineContext, FlowModel } from '@nocobase/flow-engine';
+import { APIClient } from '@nocobase/sdk';
+import type { i18n as i18next } from 'i18next';
+import React, { ReactElement, ReactNode } from 'react';
+import type { AppListProps } from '@ant-design/pro-layout/es/components/AppsLogoComponents/types';
+import { AIManager } from './ai';
+import { SystemSettingsSource } from './flow/system-settings';
+import { LayoutManager } from './layout-manager/LayoutManager';
+import type { PluginClass, PluginManager, PluginType } from './PluginManager';
+import { RouteRepository } from './RouteRepository';
+import type { ComponentTypeAndString, RenderableComponentType, RouterComponentType, RouterManager, RouterOptions } from './RouterManager';
+import { WebSocketClient, type WebSocketClientOptions } from './WebSocketClient';
+import type { RequireJS } from './utils/requirejs';
+declare global {
+    interface Window {
+        requirejs?: RequireJS;
+        define: RequireJS['define'];
+    }
+}
+type AnyComponent = RenderableComponentType<any>;
+type AppListLoader = (app: BaseApplication<any>) => Promise<AppListProps> | AppListProps;
+type AuthTokenPayload = {
+    token: string;
+    authenticator: string | null;
+};
+export type JsonLogic = {
+    apply: (logic: any, data?: any) => any;
+    addOperation: (name: string, fn?: any) => void;
+    rmOperation: (name: string) => void;
+};
+export type DevDynamicImport = (packageName: string) => Promise<{
+    default: PluginClass;
+}>;
+export type ComponentAndProps<T = any> = [AnyComponent, T];
+export interface BaseApplicationOptions<TPluginType> {
+    name?: string;
+    publicPath?: string;
+    apiClient?: any;
+    ws?: WebSocketClientOptions | boolean;
+    i18n?: i18next;
+    providers?: (AnyComponent | ComponentAndProps)[];
+    plugins?: TPluginType[];
+    components?: Record<string, AnyComponent>;
+    scopes?: Record<string, any>;
+    router?: RouterOptions;
+    designable?: boolean;
+    loadRemotePlugins?: boolean;
+    devDynamicImport?: DevDynamicImport;
+    disableAcl?: boolean;
+}
+/**
+ * 共享的应用运行时基类。
+ *
+ * 该类只负责承接 client 与 client-v2 共用的 Application 骨架，
+ * 具体产品行为通过子类钩子补齐。
+ */
+export declare abstract class BaseApplication<TOptions extends BaseApplicationOptions<any> = BaseApplicationOptions<PluginType>, TPluginManager extends PluginManager<any> = PluginManager<any>, TRouterManager extends RouterManager<any> = RouterManager<any>, TApiClient extends APIClient = APIClient, TPluginSettingsManager = any> {
+    protected options: TOptions;
+    eventBus: EventTarget;
+    providers: ComponentAndProps[];
+    router: TRouterManager;
+    scopes: Record<string, any>;
+    i18n: i18next;
+    ws: WebSocketClient;
+    apiClient: TApiClient;
+    components: Record<string, AnyComponent>;
+    pluginManager: TPluginManager;
+    pluginSettingsManager: TPluginSettingsManager;
+    layoutManager: LayoutManager<this>;
+    aiManager: AIManager;
+    devDynamicImport?: DevDynamicImport;
+    requirejs: RequireJS;
+    name: string;
+    favicon: string;
+    flowEngine: FlowEngine;
+    dataSourceManager: any;
+    jsonLogic: JsonLogic;
+    context: FlowEngineContext & {
+        routeRepository: RouteRepository;
+        appInfo: Promise<Record<string, any>>;
+        pageInfo: {
+            version?: 'v1' | 'v2';
+        };
+        systemSettings: SystemSettingsSource;
+        acl?: {
+            data: Record<string, any>;
+            meta: Record<string, any>;
+            setData: (data: Record<string, any>) => void;
+            setMeta: (meta: Record<string, any>) => void;
+        };
+        pluginManager: TPluginManager;
+    };
+    systemSettings: SystemSettingsSource;
+    maintained: boolean;
+    maintaining: boolean;
+    error: any;
+    model: ApplicationModel;
+    private wsAuthorized;
+    apps: {
+        Component?: AnyComponent | null;
+        loadAppList?: AppListLoader | null;
+    };
+    get pm(): TPluginManager;
+    get disableAcl(): boolean;
+    get isWsAuthorized(): boolean;
+    setDocumentLanguage(language?: string | null): void;
+    constructor(options?: TOptions);
+    /**
+     * 注册共享 observable 状态。
+     */
+    protected defineObservableState(): void;
+    protected initializeExtendedState(): void;
+    protected afterManagersInitialized(): void;
+    protected configureContext(): void;
+    protected configureRuntimeAdapters(): void;
+    protected addCustomProviders(): void;
+    protected initListeners(): void;
+    protected setTokenInWebSocket(options: AuthTokenPayload): void;
+    protected initRequireJs(): void;
+    /**
+     * 注入两边共享的基础 context。
+     */
+    protected configureBaseContext(): void;
+    /**
+     * 注册两边共享的默认 providers。
+     */
+    protected addBaseProviders(): void;
+    protected addFinalProviders(): void;
+    addReactRouterComponents(): void;
+    addRoutes(): void;
+    updateFavicon(favicon?: string | null): void;
+    setWsAuthorized(authorized: boolean): void;
+    setMaintaining(maintaining: boolean): void;
+    getOptions(): TOptions;
+    getName(): string;
+    getPublicPath(): string;
+    getApiUrl(pathname?: string): string;
+    getRouteUrl(pathname: string): string;
+    getHref(pathname: string): string;
+    getComposeProviders(): React.FC;
+    use<T = any>(component: AnyComponent, props?: T): number;
+    addProvider<T = any>(component: AnyComponent, props?: T): number;
+    addProviders(providers: (AnyComponent | ComponentAndProps)[]): void;
+    getComponent<T = any>(Component: ComponentTypeAndString<T>, isShowError?: boolean): AnyComponent | undefined;
+    renderComponent<T extends {}>(Component: ComponentTypeAndString, props?: T, children?: ReactNode): ReactElement | null;
+    /**
+     * @internal
+     */
+    protected addComponent(component: AnyComponent, name?: string): void;
+    addComponents(components: Record<string, AnyComponent>): void;
+    setAppsComponent({ Component }: {
+        Component: AnyComponent;
+    }): void;
+    setAppsProvider({ loadAppList }: {
+        loadAppList: AppListLoader;
+    }): void;
+    protected getRootFallback(): React.ReactElement<any, string | React.JSXElementConstructor<any>>;
+    getRootComponent(): React.FC<{
+        children?: React.ReactNode;
+    }>;
+    mount(containerOrSelector: Element | ShadowRoot | string): import("react-dom/client").Root;
+    protected abstract createApiClient(options: TOptions): TApiClient;
+    protected abstract createI18n(options: TOptions): i18next;
+    protected abstract createRouterManager(options: TOptions): TRouterManager;
+    protected abstract createPluginManager(options: TOptions): TPluginManager;
+    protected abstract createPluginSettingsManager(options: TOptions): TPluginSettingsManager;
+    protected createLayoutManager(_options: TOptions): LayoutManager<this>;
+    protected createWebSocketClient(options: TOptions): WebSocketClient;
+    protected getDefaultComponents(): Record<string, AnyComponent>;
+    abstract load(): Promise<void>;
+    abstract loadWebSocket(): Promise<void>;
+}
+/**
+ * Application 共享根模型。
+ *
+ * 该模型统一承接 app.load、错误态、维护态和主内容渲染。
+ */
+export declare class ApplicationModel extends FlowModel {
+    #private;
+    get app(): BaseApplication<BaseApplicationOptions<PluginType>, PluginManager<any>, RouterManager<any>, APIClient, any>;
+    getProviders(): AnyComponent;
+    getRouter(): RouterComponentType;
+    render(): React.JSX.Element;
+    renderMaintaining(): React.ReactElement<any, string | React.JSXElementConstructor<any>>;
+    renderMaintainingDialog(): React.ReactElement<any, string | React.JSXElementConstructor<any>>;
+    renderError(): React.ReactElement<any, string | React.JSXElementConstructor<any>>;
+    renderContent(): React.JSX.Element;
+}
+export {};

package/es/PinnedPluginListContext.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.
+ */
+/// <reference types="react" />
+import type { ComponentTypeAndString } from './RouterManager';
+export type PinnedPluginListItem = {
+    component: ComponentTypeAndString;
+    order?: number;
+    pin?: boolean;
+    snippet?: string;
+};
+export type PinnedPluginListItems = Record<string, PinnedPluginListItem>;
+export type PinnedPluginListContextValue = {
+    items: PinnedPluginListItems;
+};
+export declare const getPinnedPluginListKeys: (items?: PinnedPluginListItems) => string[];
+export declare const PinnedPluginListContext: import("react").Context<PinnedPluginListContextValue>;

package/es/Plugin.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 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 { TFuncKey, TOptions } from 'i18next';
+import type { BaseApplication } from './BaseApplication';
+import { Application } from './Application';
+/**
+ * 插件配置选项。
+ *
+ * 作为 Plugin 类的泛型参数，描述插件注册时可接收的配置项。
+ *
+ * @template T 插件自定义配置类型
+ */
+export interface PluginOptions<T = any> {
+    name?: string;
+    packageName?: string;
+    options?: any;
+    config?: T;
+    [key: string]: any;
+}
+export declare class Plugin<T extends PluginOptions<any> = PluginOptions, TApp extends BaseApplication<any> = Application> {
+    options: T;
+    protected app: TApp;
+    constructor(options: T, app: TApp);
+    get pluginManager(): import("./PluginManager").PluginManager<any>;
+    get context(): import("@nocobase/flow-engine").FlowEngineContext & {
+        routeRepository: import("./RouteRepository").RouteRepository;
+        appInfo: Promise<Record<string, any>>;
+        pageInfo: {
+            version?: "v1" | "v2";
+        };
+        systemSettings: import("./flow").SystemSettingsSource;
+        acl?: {
+            data: Record<string, any>;
+            meta: Record<string, any>;
+            setData: (data: Record<string, any>) => void;
+            setMeta: (meta: Record<string, any>) => void;
+        };
+        pluginManager: import("./PluginManager").PluginManager<any>;
+    };
+    get flowEngine(): import("@nocobase/flow-engine").FlowEngine;
+    get engine(): import("@nocobase/flow-engine").FlowEngine;
+    get pm(): import("./PluginManager").PluginManager<any>;
+    get router(): import("./RouterManager").RouterManager<any>;
+    get pluginSettingsManager(): any;
+    get schemaInitializerManager(): any;
+    get schemaSettingsManager(): any;
+    get dataSourceManager(): any;
+    get ai(): import("./ai").AIManager;
+    afterAdd(): Promise<void>;
+    beforeLoad(): Promise<void>;
+    load(): Promise<void>;
+    t(text: TFuncKey | TFuncKey[], options?: TOptions): import("i18next").TFunctionDetailedResult<object>;
+}

package/es/PluginManager.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 { Plugin, PluginOptions } from './Plugin';
+export type PluginClass<Opts = any, TApp extends BaseApplication<any> = BaseApplication<any>> = new (options: PluginOptions<Opts>, app: TApp) => Plugin<PluginOptions<Opts>, TApp>;
+export type PluginType<Opts = any, TApp extends BaseApplication<any> = BaseApplication<any>> = PluginClass<Opts, TApp> | [PluginClass<Opts, TApp>, PluginOptions<Opts>];
+export type PluginClassLike<TApp extends BaseApplication<any> = BaseApplication<any>> = PluginClass<any, TApp>;
+export type PluginTypeLike<TApp extends BaseApplication<any> = BaseApplication<any>> = PluginType<any, TApp>;
+export type PluginData = {
+    name: string;
+    packageName: string;
+    version: string;
+    url: string;
+    clientV2Url?: string;
+    devMode?: 'esm';
+    appDevDependencies?: string[];
+    type: 'local' | 'upload' | 'npm';
+};
+export declare class PluginManager<TApp extends BaseApplication<any> = BaseApplication<any>> {
+    protected _plugins: PluginType<any, TApp>[] | undefined;
+    protected loadRemotePlugins: boolean | undefined;
+    protected app: TApp;
+    protected pluginInstances: Map<PluginClass<any, TApp>, Plugin<any, TApp>>;
+    protected pluginsAliases: Record<string, Plugin<any, TApp>>;
+    private initPlugins;
+    constructor(_plugins: PluginType<any, TApp>[] | undefined, loadRemotePlugins: boolean | undefined, app: TApp);
+    /**
+     * @internal
+     */
+    init(_plugins: PluginType<any, TApp>[]): Promise<void>;
+    protected getRemotePluginsRequestUrl(): string;
+    private initStaticPlugins;
+    protected initRemotePlugins(): Promise<void>;
+    add<T = any>(plugin: PluginClass<T, TApp>, opts?: PluginOptions<T>): Promise<void>;
+    get<T extends PluginClass<any, TApp>>(PluginClass: T): InstanceType<T>;
+    get<T extends {}>(name: string): T;
+    protected getInstance<T>(plugin: PluginClass<T, TApp>, opts?: PluginOptions<T>): Plugin<PluginOptions<T>, TApp>;
+    /**
+     * @internal
+     */
+    load(): Promise<void>;
+}

package/es/PluginSettingsManager.d.ts

@@ -0,0 +1,206 @@
+/**
+ * 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, { type ReactNode } from 'react';
+import type { BaseApplication } from './BaseApplication';
+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 PluginSettingsMenuItemOptions {
+    key: string;
+    title?: React.ReactNode;
+    icon?: string | ReactNode;
+    /**
+     * sort, the smaller the number, the higher the priority
+     *
+     * @default 0
+     */
+    sort?: number;
+    aclSnippet?: string;
+    isPinned?: boolean;
+    hidden?: boolean;
+    showTabs?: boolean;
+    [index: string]: any;
+}
+export interface PluginSettingsPageItemOptions {
+    menuKey: string;
+    key: string;
+    title?: React.ReactNode;
+    Component?: RouteType['Component'];
+    componentLoader?: RouteType['componentLoader'];
+    sort?: number;
+    aclSnippet?: string;
+    link?: string;
+    hidden?: boolean;
+    [index: string]: any;
+}
+export interface PluginSettingsPageType {
+    readonly label?: React.ReactNode;
+    readonly title?: React.ReactNode;
+    readonly link?: string;
+    readonly key: string;
+    readonly menuKey: string;
+    readonly pageKey?: string;
+    readonly pluginKey?: string;
+    readonly icon?: ReactNode;
+    readonly path: string;
+    readonly sort?: number;
+    readonly name: string;
+    readonly isAllow: boolean;
+    readonly isTopLevel: boolean;
+    readonly topLevelName: string;
+    readonly aclSnippet: string | null;
+    readonly isPinned?: boolean;
+    readonly hidden?: boolean;
+    readonly showTabs?: boolean;
+    readonly Component?: RouteType['Component'];
+    readonly componentLoader?: RouteType['componentLoader'];
+    readonly children?: readonly PluginSettingsPageType[];
+    readonly [index: string]: any;
+}
+interface InternalMenuItemRecord extends PluginSettingsMenuItemOptions {
+    name: string;
+    Component: RouteType['Component'];
+}
+interface InternalPageItemRecord extends PluginSettingsPageItemOptions {
+    name: string;
+}
+/**
+ * Client V2 settings 注册与查询管理器。
+ *
+ * 内部仅维护两层结构：menu item 与 page item。
+ * 对外继续暴露稳定的查询接口，返回克隆后的快照，避免消费侧意外污染内部状态。
+ *
+ * @example
+ * ```typescript
+ * app.pluginSettingsManager.addMenuItem({ key: 'system-settings', title: 'System settings' });
+ * app.pluginSettingsManager.addPageTabItem({ menuKey: 'system-settings', key: 'index', componentLoader: async () => ({ default: Page }) });
+ * ```
+ */
+export declare class PluginSettingsManager<TApp extends BaseApplication<any> = BaseApplication<any>> {
+    protected menus: Record<string, InternalMenuItemRecord>;
+    protected pages: Record<string, InternalPageItemRecord>;
+    protected aclSnippets: string[];
+    app: TApp;
+    private cachedList;
+    constructor(app: TApp);
+    /**
+     * 清理查询缓存。
+     *
+     * @returns {void}
+     */
+    clearCache(): void;
+    /**
+     * 设置 ACL snippets。
+     *
+     * @param {string[]} aclSnippets 当前角色的 snippets
+     * @returns {void}
+     */
+    setAclSnippets(aclSnippets: string[]): void;
+    /**
+     * 获取指定 settings 项的 ACL snippet。
+     *
+     * @param {string} name settings 名称
+     * @returns {string | null} ACL snippet
+     */
+    getAclSnippet(name: string): string;
+    /**
+     * 获取 route id。
+     *
+     * @param {string} name settings 名称
+     * @returns {string} route id
+     */
+    getRouteName(name: string): string;
+    /**
+     * 获取 settings 对应的绝对路径。
+     *
+     * @param {string} name menu 或 page 名称
+     * @returns {string} settings 绝对路径
+     */
+    getRoutePath(name: string): string;
+    /**
+     * 注册或更新 menu item。
+     *
+     * @param {PluginSettingsMenuItemOptions} options menu 配置
+     * @returns {void}
+     * @throws {Error} 当路径与其他配置冲突时抛错
+     */
+    addMenuItem(options: PluginSettingsMenuItemOptions): void;
+    /**
+     * 注册或更新 page item。
+     *
+     * @param {PluginSettingsPageItemOptions} options page 配置
+     * @returns {void}
+     * @throws {Error} 当 menu 不存在或路径冲突时抛错
+     */
+    addPageTabItem(options: PluginSettingsPageItemOptions): void;
+    /**
+     * 删除 menu 或 page。
+     *
+     * 删除 menu 时会级联删除其下全部 pages；删除 page 时仅删除单页。
+     *
+     * @param {string} name menu 或 page 名称
+     * @returns {void}
+     */
+    remove(name: string): void;
+    /**
+     * 判断当前 settings 是否有权限访问。
+     *
+     * @param {string} name settings 名称
+     * @returns {boolean} 是否允许访问
+     */
+    hasAuth(name: string): boolean;
+    /**
+     * 判断指定 settings 是否已注册。
+     *
+     * 该判断不受 ACL 与 hidden 影响。
+     *
+     * @param {string} name menu 或 page 名称
+     * @returns {boolean} 是否已注册
+     */
+    has(name: string): boolean;
+    /**
+     * 获取单个 menu 或 page 的只读快照。
+     *
+     * @param {string} name menu 或 page 名称
+     * @param {boolean} [filterAuth=true] 是否按 ACL 过滤
+     * @returns {PluginSettingsPageType | null} 快照结果
+     */
+    get(name: string, filterAuth?: boolean): PluginSettingsPageType | null;
+    /**
+     * 获取顶级 menu 列表的只读快照。
+     *
+     * @param {boolean} [filterAuth=true] 是否按 ACL 过滤
+     * @returns {PluginSettingsPageType[]} 顶级 menu 列表
+     */
+    getList(filterAuth?: boolean): PluginSettingsPageType[];
+    /**
+     * 获取全部已注册 settings 的 ACL snippets。
+     *
+     * @returns {(string | null)[]} ACL snippets
+     */
+    getAclSnippets(): string[];
+    protected renderIcon(icon: PluginSettingsMenuItemOptions['icon']): ReactNode;
+    private buildSnapshot;
+    private buildMenuSnapshot;
+    private buildPageSnapshot;
+    private cloneSnapshot;
+    private sortMenuNames;
+    private sortPageNames;
+    private getPageNamesByMenu;
+    private getPageName;
+    private parseName;
+    private syncMenuRoute;
+    private syncPageRoute;
+    private assertIndexConflict;
+    private assertPathConflict;
+    private isMenuIndexPair;
+    private assertMenuKey;
+}
+export {};