@zl-ui-kit/composables 0.4.0 → 0.5.0

package/README.md

@@ -9,22 +9,22 @@ ZL UI 组合式函数库（TypeScript）：
 | --- | --- |
 | `useRequest/useDataRequest/usePaginationRequest/usePageableRequest` | 请求体系（插件机制：loading/ready/refreshDeps/download，可 `defineUseRequestPlugin` 自定义） |
 | `useGlobalMessage` | **Element Plus 版** ElMessage/ElMessageBox/ElNotification 封装；`Modal.confirmPromise` 语义与参考实现一致 |
-| `useMicroApp/useMicroAction/useMicroGlobalData` | micro-app 微前端通信层（globalData/事件派发/主子身份） |
-| `useDict/useDictStore/useDictProvider/setDictSource` | 字典（独立 Vue3 状态管理 store 缓存，不依赖微前端；支持组件直传 / 局部 source / 全局 source 三级注入） |
-| `useLocale` | vue-i18n + 主应用语言联动（`elLocaleMessages` 对接 EP locale） |
-| `usePageTabs` | 多应用页签管理 |
+| `useGlobalData` | 全局应用数据（locale / theme / token / 用户 / 权限 / config），纯 `localStorage` 持久化 |
+| `useDict/useDictStore/useDictProvider/setDictSource` | 字典（独立 Vue3 状态管理 store 缓存，不依赖全局数据；支持组件直传 / 局部 source / 全局 source 三级注入） |
+| `useLocale` | vue-i18n + 全局语言联动（`elLocaleMessages` 对接 EP locale） |
 | `useSash/useServiceType/useUKey/createCacheComputed` | 其他工具 hook |
 
-## 运行前提（微前端模块）
+## 运行前提
 
-`@micro-zoe/micro-app` 是**可选 peer**（0.3.2 起）。`useMicroApp` / `useMicroAction` / `usePageTabs` 在缺失时会抛出带安装指引的错误；`useMicroGlobalData` 则**自动降级**为本地存储模式（`$zl_locale` / `$zl_theme` / `$zl_token`），因此 `useLocale`、主题、字典在纯 Web 应用中照常可用。
+**无微前端依赖**：0.5.0 起本包不再包含任何微前端代码，`@micro-zoe/micro-app` 已从 peer 依赖中移除，
+产物里也没有它的静态 import（旧版在 Node 原生 ESM / SSR 下会因这条 import 报 `ERR_MODULE_NOT_FOUND`）。
 
-```bash
-# 只在用微前端时才需要
-npm i @micro-zoe/micro-app
-```
+全局数据（语言 / 主题 / 令牌 / 用户 / 权限 / `config`）由 `useGlobalData()` 提供：
+`locale` / `theme` / `token` 经 `useStorage` 持久化到 `$zl_locale` / `$zl_theme` / `$zl_token`，
+其余字段为内存态、由宿主自行写入。旧名 `useMicroGlobalData` 与 `useMicroApp` / `useMicroAction` /
+`usePageTabs` / `enableGlobalDataMock` 均已移除。
 
-`enableGlobalDataMock()` 仍保留用于强制 mock 调试，但**不再是**使用 `useMicroGlobalData` 的必要条件。字典模块（`useDict` 等）本身不依赖微前端。
+`useLocale`、`ZlI18nProvider`、主题、字典等能力的行为与用法不变。
 
 ## 本地调试
 

package/dist/index.d.ts

@@ -1,6 +1,5 @@
 import * as vue from 'vue';
-import { ComputedRef, InjectionKey, WritableComputedRef, Ref, Component, VNode, MaybeRef, MaybeRefOrGetter, WatchSource, UnwrapRef, ref } from 'vue';
-export { ComputedRef } from 'vue';
+import { ComputedRef, InjectionKey, Ref, WritableComputedRef, MaybeRef, MaybeRefOrGetter, WatchSource, UnwrapRef, ref } from 'vue';
 import { ElMessageBoxOptions, ElMessage, ElMessageBox, ElNotification } from 'element-plus';
 import { I18nOptions, I18n } from 'vue-i18n';
 
@@ -90,6 +89,49 @@ interface UseDictOptions {
  */
 declare function useDict(key: string, options?: UseDictOptions): UseDictReturn;
 
+/**
+ * 全局应用数据（语言 / 主题 / 令牌 / 用户 / 权限 / 配置）
+ *
+ * 纯前端实现：只依赖 `useStorage`（localStorage）与组件内响应式状态，
+ * **不依赖任何微前端框架**。存储键沿用 `$zl_locale` / `$zl_theme` / `$zl_token`，
+ * 从旧版 `useMicroGlobalData` 升级过来时已持久化的数据不会丢。
+ */
+
+interface GlobalDataState {
+    initialed: boolean;
+    locale: string;
+    theme: string;
+    token: string | undefined;
+    isI18nKeyVisible: boolean;
+    roles: string[];
+    permissions: string[];
+    user: any;
+    localeMessages: Record<string, any>;
+    elLocaleMessages: any;
+    config: Record<string, any> | undefined;
+}
+interface UseGlobalDataReturn extends Ref<Partial<GlobalDataState>> {
+    initialed: Readonly<Ref<boolean>>;
+    locale: WritableComputedRef<string>;
+    theme: WritableComputedRef<string>;
+    token: WritableComputedRef<string | undefined>;
+    isI18nKeyVisible: WritableComputedRef<boolean>;
+    roles: WritableComputedRef<string[]>;
+    permissions: WritableComputedRef<string[]>;
+    user: WritableComputedRef<any>;
+    localeMessages: WritableComputedRef<Record<string, any>>;
+    elLocaleMessages: WritableComputedRef<any>;
+    config: WritableComputedRef<Record<string, any> | undefined>;
+    getConfig: <T = any>(key: string, defaultValue?: T) => T;
+    isConfig: (key: string, compareValue?: string) => boolean;
+    setAndWaitUntil: (options: {
+        set?: Record<string, any>;
+        until?: (data: any) => boolean;
+    }) => Promise<void>;
+    resetUser: () => void;
+}
+declare const useGlobalData: () => UseGlobalDataReturn;
+
 /**
  * 全局消息（Element Plus 版）
  * 对外保持参考实现 API：Message / Modal（含 confirmPromise 扩展）/ Notification
@@ -124,7 +166,7 @@ interface GlobalMessage {
 declare function useGlobalMessage(_directMode?: boolean): GlobalMessage;
 
 /**
- * 国际化（vue-i18n）+ 微前端全局语言联动（elLocaleMessages 对接 Element Plus locale）
+ * 国际化（vue-i18n）+ 全局语言联动（elLocaleMessages 对接 Element Plus locale）
  */
 
 interface LocaleLoaderResult {
@@ -147,208 +189,6 @@ interface UseLocaleReturn {
  */
 declare function useLocale(options?: UseLocaleOptions, loader?: LocaleLoader): UseLocaleReturn;
 
-/**
- * 安全的国际化翻译函数（组件库渐进式接入 vue-i18n 的桥梁）。
- *
- * - 若宿主已 `app.use(i18n)` 安装 vue-i18n：委托其全局 t 进行翻译；
- * - 若宿主未接入 i18n（存量应用）：安全降级为 fallback / key，绝不抛错。
- *
- * 这样组件库可在「不破坏现有消费方」的前提下，逐步把硬编码中文替换为
- * `t('zl.xxx', '中文兜底')`，待宿主统一安装 i18n 后即自动多语言化。
- */
-/** 命名插值参数，如 t('zl.upload.accept', fallback, { accept: '.png' }) */
-type TranslateParams = Record<string, unknown>;
-/**
- * @param key      语言包 key（规范：`zl.<组件>.<语义>`）
- * @param fallback 兜底文案（宿主未装 i18n / key 未命中时使用；可传入已插值的字符串）
- * @param params   命名插值参数（命中语言包时由 vue-i18n 插值 `{name}` 占位）
- */
-type Translate = (key: string, fallback?: string, params?: TranslateParams) => string;
-declare function useZlT(): {
-    t: Translate;
-};
-
-/**
- * micro-app 跨应用动作通信层（主/子应用事件总线语义）
- */
-type MicroActionCallback = (...args: any[]) => void;
-interface UseMicroListenerReturn {
-    on: (action: string, callback: MicroActionCallback) => void;
-    off: (action: string, callback: MicroActionCallback) => void;
-    once: (action: string, callback: MicroActionCallback) => void;
-}
-declare const useMicroListener: () => UseMicroListenerReturn;
-/**
- * 向子应用（或指定应用）派发动作，返回可直接调用的派发函数
- */
-declare function useMicroAction(action: string, appName?: string): (...args: any[]) => void;
-/**
- * 派发动作并等待 Promise 化结果
- */
-declare function useMicroActionAsync(action: string, appName?: string): (...args: any[]) => Promise<unknown>;
-/**
- * 监听动作的执行结果
- */
-declare function useMicroResultListener(action: string, callback: MicroActionCallback): void;
-/**
- * 向指定子应用派发动作（回调式）
- */
-declare function dispatchMicroAction(action: string, appName: string, ...data: any[]): Promise<void>;
-
-/**
- * micro-app 微应用管理（主/子应用身份判断、启动、活跃应用列表）
- */
-
-interface StartMicroAppConfig {
-    [key: string]: any;
-    lifeCycles?: {
-        mounted?: (data?: any) => void;
-        unmounted?: (data?: any) => void;
-    };
-}
-interface UseMicroAppReturn {
-    apps: Ref<string[]>;
-    /** 是否主应用（多层嵌套时可同时为子应用） */
-    isMicroBase: () => boolean;
-    /** 是否子应用（多层嵌套时可同时为主应用） */
-    isMicroChild: () => boolean;
-    updateApps: () => void;
-    startMicroApp: (config?: StartMicroAppConfig) => any;
-}
-declare const useMicroApp: () => UseMicroAppReturn;
-
-/**
- * micro-app 全局数据（globalData）响应式访问层
- * 脱敏/注入式改造（需求 §7.3、§12-Q3）：
- * - 存储键 $zl_locale/$zl_theme/$zl_token
- * - arcoLocaleMessages → elLocaleMessages（Element Plus locale）
- * - 原 import.meta.env 开发的 mock 开关改为 enableGlobalDataMock() 显式开启（首次 useMicroGlobalData 前调用）
- */
-
-/**
- * 开发态启用本地 mock globalData（原实现经构建环境变量开启，现显式注入）
- */
-declare function enableGlobalDataMock(enabled?: boolean): void;
-interface GlobalDataState {
-    initialed: boolean;
-    locale: string;
-    theme: string;
-    token: string | undefined;
-    isI18nKeyVisible: boolean;
-    roles: string[];
-    permissions: string[];
-    user: any;
-    localeMessages: Record<string, any>;
-    elLocaleMessages: any;
-    config: Record<string, any> | undefined;
-}
-interface UseMicroGlobalDataReturn extends Ref<Partial<GlobalDataState>> {
-    initialed: Readonly<Ref<boolean>>;
-    locale: WritableComputedRef<string>;
-    theme: WritableComputedRef<string>;
-    token: WritableComputedRef<string | undefined>;
-    isI18nKeyVisible: WritableComputedRef<boolean>;
-    roles: WritableComputedRef<string[]>;
-    permissions: WritableComputedRef<string[]>;
-    user: WritableComputedRef<any>;
-    localeMessages: WritableComputedRef<Record<string, any>>;
-    elLocaleMessages: WritableComputedRef<any>;
-    config: WritableComputedRef<Record<string, any> | undefined>;
-    getConfig: <T = any>(key: string, defaultValue?: T) => T;
-    isConfig: (key: string, compareValue?: string) => boolean;
-    setAndWaitUntil: (options: {
-        set?: Record<string, any>;
-        until?: (data: any) => boolean;
-    }) => Promise<void>;
-    resetUser: () => void;
-}
-declare const useMicroGlobalData: () => UseMicroGlobalDataReturn;
-
-type RootOptions = RootComponentOptions | RootMicroOptions;
-interface RootComponentOptions {
-    title: string;
-    key: string;
-    icon?: string;
-    component: Component;
-}
-interface RootMicroOptions {
-    title: string;
-    key: string;
-    icon?: string;
-    micro: string;
-    url: string;
-}
-interface RootStore {
-    tabs: TabStored[];
-    activeTabKey: string;
-    _parentTabMap?: Record<string, TabStored>;
-    _parentMap: Record<string, any>;
-}
-type Tab = ComponentTab | MicroTab;
-type TabStored = Tab & {
-    isRoot?: boolean;
-    isChildRoot?: boolean;
-    isChild?: boolean;
-    isChildMicro?: boolean;
-    rootKey?: string;
-    micro?: string;
-    url?: string;
-    children?: TabStored[];
-    parentTab?: TabStored;
-    /** 用于删除本 tab 时，获取父 Tab 的实例 */
-    _parentTabKey?: string;
-    /** 子 root 页签标识（micro__key） */
-    childRootTabKey?: string;
-    /** 组件页签对外暴露的实例（供回调获取） */
-    exposed?: any;
-};
-interface ComponentTab {
-    key: string;
-    title: string;
-    icon?: string;
-    beforeRemove?: () => boolean | void | Promise<boolean | void>;
-    component: Component;
-    props?: Record<string, any>;
-}
-interface MicroTab {
-    key: string;
-    title: string;
-    icon?: string;
-    beforeRemove?: () => boolean | void | Promise<boolean | void>;
-    micro: string;
-    url: string;
-}
-type ComponentTabVNode = VNode;
-
-/**
- * 页签管理（micro-app 多应用页签模型：root 树 → 扁平页签 → 当前激活页签）
- * 内部逻辑保持参考实现语义；类型签名见 ./types/usePageTabs
- */
-
-interface UsePageTabsReturn {
-    roots: Record<string, RootStore | undefined>;
-    activeRoot: ComputedRef<RootStore | null>;
-    pageTabs: ComputedRef<TabStored[]>;
-    current: ComputedRef<TabStored | undefined>;
-    micros: Readonly<Record<string, string>>;
-    activeRootKey: Readonly<Ref<string | null>>;
-    addMicro: (option: {
-        micro?: string;
-        url?: string;
-    }) => boolean;
-    setRootChild: (tabs: TabStored[], activeChildTabKey: string, micro: string) => void;
-    createPageTabsRoot: (root: RootOptions) => void;
-    addPageTab: (tab: Tab & Record<string, any>, options?: {
-        update?: boolean;
-        childMicro?: boolean;
-    }) => boolean;
-    removePageTab: (tabOrKey?: TabStored | string) => Promise<void | [TabStored, TabStored] | false>;
-    removeCurrentTab: (callback?: (exposed?: any) => Promise<void> | void) => Promise<boolean | void>;
-    clearPageTab: (rootKey?: string) => void;
-    setCurrentTab: (tab: TabStored) => Promise<void>;
-}
-declare function usePageTabs(): UsePageTabsReturn;
-
 type Prettify<T> = {
     [K in keyof T]: T[K];
 } & {};
@@ -591,4 +431,25 @@ interface UseUKeyReturn {
 }
 declare const useUKey: () => UseUKeyReturn;
 
-export { type CacheComputed, type ComponentTab, type ComponentTabVNode, type ConfirmPromise, type ConfirmPromiseContext, type ConfirmPromiseOptions, DEFAULT_PAGINATION_OPTIONS, type DictInjectContext, type DictItem, type DictSource, type FunctionContext, GLOBAL_OPTIONS_PROVIDER_KEY, type GlobalDataState, type GlobalMessage, type GlobalOptions, type LocaleLoader, type LocaleLoaderResult, type MessageBoxExt, type MicroActionCallback, type MicroTab, type MutateFunction, type Options, type PaginationExtendsOptions, type PluginDownloadOptions, type PluginImplementType, type PluginLoadingOptions, type PluginOnBeforeReturn, type PluginReadyOptions, type PluginRefreshDepsOptions, type PluginReturn, type Prettify, type RequestInstance, type RequestOptions, type RequestStatus, type RootComponentOptions, type RootMicroOptions, type RootOptions, type RootStore, type Service, type StartMicroAppConfig, type State, type Tab, type TabStored, type Translate, type TranslateParams, type UKeyCSRData, type UKeyDeviceInfo, type UKeyRequestData, type UnwrapRefObject, type UnwrapState, type UseDataRequestOptions, type UseDataRequestReturn, type UseDictOptions, type UseDictReturn, type UseLocaleOptions, type UseLocaleReturn, type UseMicroAppReturn, type UseMicroGlobalDataReturn, type UseMicroListenerReturn, type UsePageTabsReturn, type UsePageableRequestReturn, type UsePaginationRequestOptions, type UsePaginationRequestReturn, type UseRequestReturn, type UseSashOptions, type UseSashReturn, type UseServiceTypeOptions, type UseServiceTypeReturn, type UseUKeyReturn, clearGlobalOptions, createCacheComputed, definePlugin as defineUseRequestPlugin, dictInjectKey, dispatchMicroAction, enableGlobalDataMock, getDictSource, getGlobalOptions, mergeMessages, setDictSource, setGlobalOptions, useDataRequest, useDict, useDictProvider, useDictStore, useGlobalMessage, useLocale, useMicroAction, useMicroActionAsync, useMicroApp, useMicroGlobalData, useMicroListener, useMicroResultListener, usePageTabs, usePageableRequest, usePaginationRequest, useRequest, useRequestProvider, useSash, useServiceType, useUKey, useZlT };
+/**
+ * 安全的国际化翻译函数（组件库渐进式接入 vue-i18n 的桥梁）。
+ *
+ * - 若宿主已 `app.use(i18n)` 安装 vue-i18n：委托其全局 t 进行翻译；
+ * - 若宿主未接入 i18n（存量应用）：安全降级为 fallback / key，绝不抛错。
+ *
+ * 这样组件库可在「不破坏现有消费方」的前提下，逐步把硬编码中文替换为
+ * `t('zl.xxx', '中文兜底')`，待宿主统一安装 i18n 后即自动多语言化。
+ */
+/** 命名插值参数，如 t('zl.upload.accept', fallback, { accept: '.png' }) */
+type TranslateParams = Record<string, unknown>;
+/**
+ * @param key      语言包 key（规范：`zl.<组件>.<语义>`）
+ * @param fallback 兜底文案（宿主未装 i18n / key 未命中时使用；可传入已插值的字符串）
+ * @param params   命名插值参数（命中语言包时由 vue-i18n 插值 `{name}` 占位）
+ */
+type Translate = (key: string, fallback?: string, params?: TranslateParams) => string;
+declare function useZlT(): {
+    t: Translate;
+};
+
+export { type CacheComputed, type ConfirmPromise, type ConfirmPromiseContext, type ConfirmPromiseOptions, DEFAULT_PAGINATION_OPTIONS, type DictInjectContext, type DictItem, type DictSource, type FunctionContext, GLOBAL_OPTIONS_PROVIDER_KEY, type GlobalDataState, type GlobalMessage, type GlobalOptions, type LocaleLoader, type LocaleLoaderResult, type MessageBoxExt, type MutateFunction, type Options, type PaginationExtendsOptions, type PluginDownloadOptions, type PluginImplementType, type PluginLoadingOptions, type PluginOnBeforeReturn, type PluginReadyOptions, type PluginRefreshDepsOptions, type PluginReturn, type Prettify, type RequestInstance, type RequestOptions, type RequestStatus, type Service, type State, type Translate, type TranslateParams, type UKeyCSRData, type UKeyDeviceInfo, type UKeyRequestData, type UnwrapRefObject, type UnwrapState, type UseDataRequestOptions, type UseDataRequestReturn, type UseDictOptions, type UseDictReturn, type UseGlobalDataReturn, type UseLocaleOptions, type UseLocaleReturn, type UsePageableRequestReturn, type UsePaginationRequestOptions, type UsePaginationRequestReturn, type UseRequestReturn, type UseSashOptions, type UseSashReturn, type UseServiceTypeOptions, type UseServiceTypeReturn, type UseUKeyReturn, clearGlobalOptions, createCacheComputed, definePlugin as defineUseRequestPlugin, dictInjectKey, getDictSource, getGlobalOptions, mergeMessages, setDictSource, setGlobalOptions, useDataRequest, useDict, useDictProvider, useDictStore, useGlobalData, useGlobalMessage, useLocale, usePageableRequest, usePaginationRequest, useRequest, useRequestProvider, useSash, useServiceType, useUKey, useZlT };