@done-coding/admin-core 0.12.1 → 0.12.2-alpha.0

package/types/bridge/config-hook.d.ts

@@ -1,99 +1,31 @@
 import { DeepReadonly } from 'vue';
 import { AppBaseInfo, AppLayoutHeaderConfig, AppLayoutFooterConfig, AppLayoutSidebarConfig, AppLayoutAsideConfig, AppLayoutBreadcrumbConfig, AppLayoutBodyConfig, AppLayoutViewportConfig, AppLayoutGapConfig, AppThemeConfig, AppLayoutConfig } from './index';
-/**
- * 可 update 的响应式配置字段 key 联合（插件系统一期 7 个 + viewport 边框期补 1 = 8 个）。
- *
- * #插件系统一期：bridge 的布局/主题/基础信息字段下沉为 reactive 响应式，
- * 经 `update(key, partial)` 单字段一级浅合并触发。viewport 边框期新增
- * `APP_LAYOUT_VIEWPORT_CONFIG`（同属布局子，纳入本联合 + layoutAggregate）。
- * 其余 init 字段（env / cache / router 族 / userInfoAccess）非响应式范围，[MUST NOT] 纳入本联合。
- */
 export type UpdatableConfigKey = "APP_BASE_INFO" | "APP_LAYOUT_HEADER_CONFIG" | "APP_LAYOUT_FOOTER_CONFIG" | "APP_LAYOUT_SIDEBAR_CONFIG" | "APP_LAYOUT_ASIDE_CONFIG" | "APP_LAYOUT_BREADCRUMB_CONFIG" | "APP_LAYOUT_BODY_CONFIG" | "APP_LAYOUT_VIEWPORT_CONFIG" | "APP_LAYOUT_GAP_CONFIG" | "APP_THEME_CONFIG";
-/**
- * 7 个可 update 字段 key → 值类型映射。
- *
- * `update<K>(key, partial)` 的 `partial` 类型经 `Partial<UpdatableConfigMap[K]>`
- * 推导；`createBridgeConfigHook` 的 init 入参亦以本映射约束（见 `BridgeConfigInit`）。
- */
 export interface UpdatableConfigMap {
-    /** 应用基础信息 */
     APP_BASE_INFO: AppBaseInfo;
-    /** 应用布局-header 配置 */
     APP_LAYOUT_HEADER_CONFIG: AppLayoutHeaderConfig;
-    /** 应用布局-footer 配置 */
     APP_LAYOUT_FOOTER_CONFIG: AppLayoutFooterConfig;
-    /** 应用布局-sidebar 配置 */
     APP_LAYOUT_SIDEBAR_CONFIG: AppLayoutSidebarConfig;
-    /** 应用布局-aside 右侧补充区配置（P1' additive） */
     APP_LAYOUT_ASIDE_CONFIG: AppLayoutAsideConfig;
-    /** 应用布局-面包屑配置 */
     APP_LAYOUT_BREADCRUMB_CONFIG: AppLayoutBreadcrumbConfig;
-    /** 应用布局-页面主体配置 */
     APP_LAYOUT_BODY_CONFIG: AppLayoutBodyConfig;
-    /** 应用布局-视口边框配置 */
     APP_LAYOUT_VIEWPORT_CONFIG: AppLayoutViewportConfig;
-    /** 应用布局-模块间距配置（内缝 gap） */
     APP_LAYOUT_GAP_CONFIG: AppLayoutGapConfig;
-    /** 应用主题配置 */
     APP_THEME_CONFIG: AppThemeConfig;
 }
-/**
- * `createBridgeConfigHook` 入参类型——7 个本期响应式字段的初值（= `UpdatableConfigMap`）。
- *
- * 由 `createAdminBridge` 闭包内从 `options` 的对应 7 字段直传；入参字段对象将被
- * 直接 `reactive()` 化（方案 A，[MUST NOT] 浅拷贝），故 [MUST] 为去 freeze 后的非
- * frozen 裸对象（app 端去字段级 freeze 保证）。
- */
 export type BridgeConfigInit = UpdatableConfigMap;
-/**
- * configHook 内部返回契约——`update` 方法 + 8 个对外 readonly 视图。
- *
- * **不对外 export**：`createBridgeConfigHook` / 本 interface / 上述类型符号 [MUST NOT]
- * 在 `bridge/index.ts` re-export（守封装边界）。`bridge/index.ts` 仅内部 import 工厂，
- * 把 `update` 与各 `roXxx` 视图组装进 `AdminBridge` 公开面。
- *
- * 7 个 readonly 视图各为对应 reactive 子配置的 `readonly()` 深只读包装；`roLayout`
- * 为 5 布局子的 `reactive({...})` 聚合的 readonly 包装——5 字段指向各 reactive 子配置，
- * 任一布局子 `update` 原地改经叶子代理同步跟随（Vue reactive 深度转换保留嵌套响应式），零拷贝。
- */
 export interface BridgeConfigHook {
-    /** 单字段一级浅合并 update（`Object.assign` 派发到对应 reactive 子配置） */
     update: <K extends UpdatableConfigKey>(key: K, partial: Partial<UpdatableConfigMap[K]>) => void;
-    /** 应用基础信息对外只读视图 */
     roBaseInfo: DeepReadonly<AppBaseInfo>;
-    /** 应用布局-header 配置对外只读视图 */
     roHeader: DeepReadonly<AppLayoutHeaderConfig>;
-    /** 应用布局-footer 配置对外只读视图 */
     roFooter: DeepReadonly<AppLayoutFooterConfig>;
-    /** 应用布局-sidebar 配置对外只读视图 */
     roSidebar: DeepReadonly<AppLayoutSidebarConfig>;
-    /** 应用布局-aside 右侧补充区配置对外只读视图（P1' additive） */
     roAside: DeepReadonly<AppLayoutAsideConfig>;
-    /** 应用布局-面包屑配置对外只读视图 */
     roBreadcrumb: DeepReadonly<AppLayoutBreadcrumbConfig>;
-    /** 应用布局-页面主体配置对外只读视图 */
     roBody: DeepReadonly<AppLayoutBodyConfig>;
-    /** 应用布局-视口边框配置对外只读视图 */
     roViewport: DeepReadonly<AppLayoutViewportConfig>;
-    /** 应用布局-模块间距配置对外只读视图（内缝 gap） */
     roGap: DeepReadonly<AppLayoutGapConfig>;
-    /** 应用主题配置对外只读视图 */
     roTheme: DeepReadonly<AppThemeConfig>;
-    /**
-     * 应用布局聚合配置只读视图（5 布局子 reactive 聚合的 readonly 包装）。
-     *
-     * `reactive({header: reactiveHeader, ...})` 5 字段指向各 reactive 子配置，任一布局子
-     * update 原地改经叶子代理同步跟随（Vue reactive 深度转换保留嵌套响应式），零拷贝。
-     */
     roLayout: DeepReadonly<AppLayoutConfig>;
 }
-/**
- * bridge 响应式配置 hook 工厂。
- *
- * 接收 7 个本期字段初值，逐字段 `reactive()` 化（方案 A：直接 reactive 入参对象，
- * [MUST NOT] 浅拷贝），内部把 5 布局子聚合为 `layoutAggregate = reactive({...})`，
- * 对外返回 `update`（单字段一级浅合并 `Object.assign`，[MUST NOT] 深合并 / merge / clone）+
- * 7 个 `readonly()` 视图 + 1 个 `roLayout`（readonly 聚合视图）。每次 `createAdminBridge`
- * 调用各自闭包内构造一份，零模块级单例（守实例隔离）。
- */
 export declare function createBridgeConfigHook(init: BridgeConfigInit): BridgeConfigHook;