@zl-ui-kit/composables 0.3.1 → 0.3.3

package/README.md

@@ -1,5 +1,8 @@
 # @zl-ui-kit/composables
 
+> **完整使用文档**：[`@zl-ui-kit/components` 的 README（npm 页面）](https://www.npmjs.com/package/@zl-ui-kit/components) 即 UI 组件权威文档 ——
+> 本包的 Hooks / 工具 / 主题 / 国际化用法都在其中，本文只保留本包速查与运行前提。
+
 ZL UI 组合式函数库（TypeScript）：
 
 | 模块 | 说明 |
@@ -14,8 +17,15 @@ ZL UI 组合式函数库（TypeScript）：
 
 ## 运行前提（微前端模块）
 
-`useMicro*`、`usePageTabs` 默认运行于 micro-app 微前端环境（决策 §12-Q11：保留并标注前提）。无主应用环境调试时可在**首次调用** `useMicroGlobalData()` 前执行 `enableGlobalDataMock()` 启用本地 mock。字典模块（`useDict` 等）已独立，不依赖微前端，可直接在任意项目中使用。
+`@micro-zoe/micro-app` 是**可选 peer**（0.3.2 起）。`useMicroApp` / `useMicroAction` / `usePageTabs` 在缺失时会抛出带安装指引的错误；`useMicroGlobalData` 则**自动降级**为本地存储模式（`$zl_locale` / `$zl_theme` / `$zl_token`），因此 `useLocale`、主题、字典在纯 Web 应用中照常可用。
+
+```bash
+# 只在用微前端时才需要
+npm i @micro-zoe/micro-app
+```
+
+`enableGlobalDataMock()` 仍保留用于强制 mock 调试，但**不再是**使用 `useMicroGlobalData` 的必要条件。字典模块（`useDict` 等）本身不依赖微前端。
 
 ## 本地调试
 
-playground alias 直指 `src/`；`pnpm build`（tsup）。详见 `docs/调试指南.md`。发布见 `docs/发布流程.md`。
+playground alias 直指 `src/`；`pnpm build`（tsup）。详见 `@zl-ui-kit/components` README §11；发布见 `docs/发布流程.md`。

package/dist/index.d.ts

@@ -3,7 +3,6 @@ import { ComputedRef, InjectionKey, WritableComputedRef, Ref, Component, VNode,
 export { ComputedRef } from 'vue';
 import { ElMessageBoxOptions, ElMessage, ElMessageBox, ElNotification } from 'element-plus';
 import { I18nOptions, I18n } from 'vue-i18n';
-import microApp from '@micro-zoe/micro-app';
 
 /**
  * 带缓存的 computed 工厂：同一对象的计算结果缓存，作用域销毁时自动清理
@@ -214,7 +213,7 @@ interface UseMicroAppReturn {
     /** 是否子应用（多层嵌套时可同时为主应用） */
     isMicroChild: () => boolean;
     updateApps: () => void;
-    startMicroApp: (config?: StartMicroAppConfig) => typeof microApp;
+    startMicroApp: (config?: StartMicroAppConfig) => any;
 }
 declare const useMicroApp: () => UseMicroAppReturn;
 

package/dist/index.js

@@ -160,10 +160,41 @@ import { createI18n } from "vue-i18n";
 
 // src/useMicroGlobalData.ts
 import { isFunction, isPlainObject as isPlainObject2, withResolvers } from "@zl-ui-kit/utils";
-import _microApp from "@micro-zoe/micro-app";
 import { createGlobalState as createGlobalState2, useStorage } from "@vueuse/core";
 import { computed as computed3, customRef, nextTick, readonly, ref as ref2, toValue, watch } from "vue";
-var microApp = window.microApp || _microApp;
+
+// src/internal/microApp.ts
+import _microApp from "@micro-zoe/micro-app";
+function usable(mod) {
+  try {
+    return mod && typeof mod.getGlobalData === "function" ? mod : void 0;
+  } catch {
+    return void 0;
+  }
+}
+function resolveMicroApp() {
+  if (typeof window !== "undefined") {
+    const injected = window.microApp;
+    if (injected)
+      return injected;
+  }
+  return usable(_microApp);
+}
+function isMicroChildRuntime() {
+  return typeof window !== "undefined" && !!window.microApp;
+}
+function requireMicroApp(api) {
+  const app = resolveMicroApp();
+  if (!app) {
+    throw new Error(
+      `[zl-ui] ${api}() \u4F9D\u8D56 micro-app\uFF0C\u8BF7\u5148\u5B89\u88C5\uFF1Anpm i @micro-zoe/micro-app
+\u82E5\u4E0D\u9700\u8981\u5FAE\u524D\u7AEF\u80FD\u529B\uFF0C\u8BF7\u6539\u7528 @zl-ui-kit/composables \u4E3B\u5165\u53E3\u4E2D\u7684\u5176\u5B83 hook\u3002`
+    );
+  }
+  return app;
+}
+
+// src/useMicroGlobalData.ts
 var devMockEnabled = false;
 function enableGlobalDataMock(enabled = true) {
   devMockEnabled = enabled;
@@ -234,7 +265,14 @@ function useDevMockGlobalData() {
   }, { getConfig, isConfig, setAndWaitUntil });
 }
 var useMicroGlobalData = createGlobalState2(() => {
-  if (devMockEnabled && !window.microApp) {
+  const microApp = resolveMicroApp();
+  if (!microApp) {
+    console.warn(
+      "[useMicroGlobalData] \u672A\u68C0\u6D4B\u5230 micro-app\uFF0C\u5DF2\u964D\u7EA7\u4E3A\u672C\u5730\u5B58\u50A8\u6A21\u5F0F\uFF08$zl_locale / $zl_theme / $zl_token\uFF09\u3002\u9700\u8981\u8DE8\u5E94\u7528\u540C\u6B65\u8BF7\u5B89\u88C5 @micro-zoe/micro-app\u3002"
+    );
+    return useDevMockGlobalData();
+  }
+  if (devMockEnabled && !isMicroChildRuntime()) {
     console.warn("[useMicroGlobalData] \u4F7F\u7528\u5F00\u53D1\u6001 mock \u6570\u636E\uFF08enableGlobalDataMock \u5DF2\u5F00\u542F\uFF09");
     return useDevMockGlobalData();
   }
@@ -336,7 +374,8 @@ var useMicroGlobalData = createGlobalState2(() => {
   });
 });
 function updateBodyAttribute(key, value) {
-  ;
+  if (typeof document === "undefined")
+    return;
   [document.body, ...document.querySelectorAll("micro-app-body")].forEach((el) => {
     el.setAttribute(key, String(value ?? ""));
   });
@@ -425,27 +464,26 @@ function useZlT() {
 }
 
 // src/useMicroAction.ts
-import microApp3 from "@micro-zoe/micro-app";
 import { createSharedComposable, tryOnScopeDispose as tryOnScopeDispose2 } from "@vueuse/core";
 import { watch as watch3 } from "vue";
 
 // src/useMicroApp.ts
-import microApp2 from "@micro-zoe/micro-app";
 import { createGlobalState as createGlobalState3 } from "@vueuse/core";
 import { ref as ref3 } from "vue";
 var useMicroApp = createGlobalState3(() => {
   const apps = ref3([]);
   function isMicroBase() {
-    return !!window.__MICRO_APP_BASE_APPLICATION__;
+    return typeof window !== "undefined" && !!window.__MICRO_APP_BASE_APPLICATION__;
   }
   function isMicroChild() {
-    return !!window.__MICRO_APP_ENVIRONMENT__;
+    return typeof window !== "undefined" && !!window.__MICRO_APP_ENVIRONMENT__;
   }
   function updateApps() {
-    apps.value = microApp2.getActiveApps();
+    apps.value = requireMicroApp("useMicroApp().updateApps").getActiveApps();
   }
   function startMicroApp(config = {}) {
-    microApp2.start({
+    const microApp = requireMicroApp("useMicroApp().startMicroApp");
+    microApp.start({
       ...config,
       lifeCycles: {
         mounted(data) {
@@ -459,7 +497,7 @@ var useMicroApp = createGlobalState3(() => {
         }
       }
     });
-    return microApp2;
+    return microApp;
   }
   return { apps, isMicroBase, isMicroChild, updateApps, startMicroApp };
 });
@@ -500,17 +538,18 @@ var useMicroListener = createSharedComposable(() => {
     });
   }
   if (isMicroBase()) {
+    const microApp = requireMicroApp("useMicroAction");
     listeners.push(() => {
       apps.value.forEach((app) => {
-        microApp3.removeDataListener(app, handler);
+        microApp.removeDataListener(app, handler);
       });
     });
     watch3(apps, (newApps, oldApps) => {
       oldApps.forEach((app) => {
-        microApp3.removeDataListener(app, handler);
+        microApp.removeDataListener(app, handler);
       });
       newApps.forEach((app) => {
-        microApp3.addDataListener(app, handler);
+        microApp.addDataListener(app, handler);
       });
     }, { deep: true });
   }
@@ -551,8 +590,11 @@ function useMicroAction(action, appName) {
   const _actionName = _action(action);
   return (...args) => {
     const _apps = !appName ? apps.value : apps.value.filter((app) => app === appName);
+    if (!_apps.length)
+      return;
+    const microApp = requireMicroApp("useMicroAction");
     _apps.forEach((app) => {
-      microApp3.setData(app, { [JSON.stringify(args)]: _actionName });
+      microApp.setData(app, { [JSON.stringify(args)]: _actionName });
     });
   };
 }
@@ -571,7 +613,8 @@ function useMicroActionAsync(action, appName) {
   if (isMicroChild()) {
     return (...args) => {
       return new Promise((resolve, reject) => {
-        microApp3.setData(appName, { [JSON.stringify(args)]: _actionName }, (promises) => {
+        const microApp = requireMicroApp("useMicroActionAsync");
+        microApp.setData(appName, { [JSON.stringify(args)]: _actionName }, (promises) => {
           Promise.all(promises).then(resolve, reject);
         });
       });
@@ -590,27 +633,27 @@ function useMicroResultListener(action, callback) {
       }
     }
   };
-  const micro = isMicroBase() ? microApp3 : window.microApp;
+  const micro = isMicroBase() ? requireMicroApp("useMicroResultListener") : typeof window !== "undefined" ? window.microApp : void 0;
   micro?.addDataListener(handler);
 }
 function dispatchMicroAction(action, appName, ...data) {
   const _actionName = _action(action);
   return new Promise((resolve) => {
-    microApp3.setData(appName, { [JSON.stringify(data)]: _actionName }, resolve);
+    requireMicroApp("dispatchMicroAction").setData(appName, { [JSON.stringify(data)]: _actionName }, resolve);
   });
 }
 
 // src/usePageTabs.ts
-import microApp4 from "@micro-zoe/micro-app";
 import { createGlobalState as createGlobalState4 } from "@vueuse/core";
 import { computed as computed4, getCurrentInstance, nextTick as nextTick2, reactive, readonly as readonly2, ref as ref4, shallowReactive, watch as watch4 } from "vue";
 function pushMicroRouter({ micro, url }) {
   if (!micro || !url)
     return;
-  const activeApps = microApp4.getActiveApps();
+  const microApp = requireMicroApp("usePageTabs");
+  const activeApps = microApp.getActiveApps();
   if (!activeApps.includes(micro))
     return;
-  return microApp4.router.push({ name: micro, path: url });
+  return microApp.router.push({ name: micro, path: url });
 }
 var createPageTabsState = createGlobalState4(() => {
   const { on } = useMicroListener();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zl-ui-kit/composables",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "type": "module",
   "description": "ZL UI 组合式函数库：useRequest 请求体系、微前端通信层、全局消息、字典、国际化等",
   "license": "MIT",
@@ -19,10 +19,10 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "@zl-ui-kit/utils": "0.3.1"
+    "@zl-ui-kit/utils": "0.3.3"
   },
   "peerDependencies": {
-    "@micro-zoe/micro-app": "1.0.0-rc.18",
+    "@micro-zoe/micro-app": ">=1.0.0-rc.10 <2",
     "@vueuse/core": "^12.3.0",
     "element-plus": "^2.9.2",
     "vue": "^3.5.13",
@@ -30,6 +30,9 @@
     "vue-router": "^4.5.0"
   },
   "peerDependenciesMeta": {
+    "@micro-zoe/micro-app": {
+      "optional": true
+    },
     "vue-router": {
       "optional": true
     }
@@ -41,8 +44,8 @@
     "cross-env": "^7.0.3",
     "tsup": "^8.3.5",
     "typescript": "^5.7.3",
-    "@jichuang/eslint-config": "1.0.0",
-    "@jichuang/tsconfig": "1.0.0"
+    "@jichuang/tsconfig": "1.0.0",
+    "@jichuang/eslint-config": "1.0.0"
   },
   "repository": {
     "type": "git",