@maxax/x-plugins-micro 1.0.0

package/dist/index.cjs

@@ -0,0 +1,196 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  MicroAppManager: () => MicroAppManager,
+  getMicroApps: () => getMicroApps,
+  hasMicroApps: () => hasMicroApps,
+  hasValidEntry: () => hasValidEntry,
+  microAppManager: () => microAppManager,
+  setupMicroPluginApps: () => setupMicroPluginApps,
+  startMicroPluginApps: () => startMicroPluginApps
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/setup.ts
+var import_qiankun = require("qiankun");
+var MicroAppManager = class {
+  constructor() {
+    /** 是否已注册微应用 */
+    __publicField(this, "hasRegistered", false);
+    /** 是否已启动微前端框架 */
+    __publicField(this, "hasStarted", false);
+    /** 微应用配置列表 */
+    __publicField(this, "apps", []);
+    /** 启动配置选项 */
+    __publicField(this, "startOptions", {});
+    /** 自定义加载器函数 */
+    __publicField(this, "loader");
+    /** 自定义错误处理函数 */
+    __publicField(this, "onError");
+  }
+  /**
+   * 检查是否有有效的微应用配置
+   * @returns 是否存在有效的微应用
+   */
+  hasMicroApps() {
+    return this.apps.length > 0;
+  }
+  /**
+   * 过滤出有效的微应用配置（必须有 entry）
+   * @param apps 微应用配置列表
+   * @returns 有效的微应用配置列表
+   */
+  filterValidApps(apps) {
+    return apps.filter((app) => {
+      return typeof app.entry === "string" && app.entry.length > 0;
+    });
+  }
+  /**
+   * 设置微前端应用
+   * @param options 设置选项
+   */
+  setup(options) {
+    if (this.hasRegistered) {
+      console.warn("[x-micro-plugin] \u5FAE\u5E94\u7528\u5DF2\u7ECF\u6CE8\u518C\uFF0C\u8DF3\u8FC7\u91CD\u590D\u6CE8\u518C");
+      return;
+    }
+    this.apps = this.filterValidApps(options.apps);
+    if (!this.hasMicroApps()) {
+      console.warn("[x-micro-plugin] \u6CA1\u6709\u6709\u6548\u7684\u5FAE\u5E94\u7528\u914D\u7F6E\uFF0C\u8DF3\u8FC7\u6CE8\u518C");
+      return;
+    }
+    this.startOptions = options.startOptions || {};
+    this.loader = options.loader;
+    this.onError = options.onError;
+    this.registerMicroApps();
+    this.setupErrorHandler();
+    this.hasRegistered = true;
+  }
+  /**
+   * 注册微应用到 qiankun
+   */
+  registerMicroApps() {
+    (0, import_qiankun.registerMicroApps)(
+      this.apps.map((app) => ({
+        name: app.name,
+        entry: app.entry,
+        container: `#${app.containerId}`,
+        activeRule: app.activeRule,
+        props: {
+          ...app.props
+        },
+        loader: (loading) => {
+          var _a;
+          (_a = this.loader) == null ? void 0 : _a.call(this, loading);
+        }
+      }))
+    );
+  }
+  /**
+   * 设置全局错误处理
+   */
+  setupErrorHandler() {
+    (0, import_qiankun.addGlobalUncaughtErrorHandler)((event) => {
+      if (this.onError) {
+        this.onError(event);
+      } else {
+        console.error("[x-micro-plugin] \u5FAE\u5E94\u7528\u52A0\u8F7D\u9519\u8BEF", event);
+        if (typeof window !== "undefined" && window.$message) {
+          console.error("\u5B50\u5E94\u7528\u52A0\u8F7D\u5931\u8D25\uFF0C\u8BF7\u7A0D\u540E\u91CD\u8BD5");
+        }
+      }
+    });
+  }
+  /**
+   * 启动微前端框架
+   */
+  start() {
+    var _a, _b, _c, _d;
+    if (!this.hasRegistered) {
+      console.warn("[x-micro-plugin] \u5FAE\u5E94\u7528\u5C1A\u672A\u6CE8\u518C\uFF0C\u8BF7\u5148\u8C03\u7528 setup() \u65B9\u6CD5");
+      return;
+    }
+    if (this.hasStarted) {
+      console.warn("[x-micro-plugin] \u5FAE\u524D\u7AEF\u6846\u67B6\u5DF2\u7ECF\u542F\u52A8\uFF0C\u8DF3\u8FC7\u91CD\u590D\u542F\u52A8");
+      return;
+    }
+    const startOpts = {
+      prefetch: this.startOptions.prefetch !== false,
+      // 默认启用预加载
+      sandbox: {
+        experimentalStyleIsolation: (_b = (_a = this.startOptions.sandbox) == null ? void 0 : _a.experimentalStyleIsolation) != null ? _b : true,
+        strictStyleIsolation: (_d = (_c = this.startOptions.sandbox) == null ? void 0 : _c.strictStyleIsolation) != null ? _d : false,
+        ...this.startOptions.sandbox
+      },
+      ...this.startOptions
+    };
+    (0, import_qiankun.start)(startOpts);
+    this.hasStarted = true;
+  }
+  /**
+   * 获取已注册的微应用配置列表
+   * @returns 微应用配置列表的只读副本
+   */
+  getApps() {
+    return [...this.apps];
+  }
+  /**
+   * 重置管理器状态（主要用于测试）
+   */
+  reset() {
+    this.hasRegistered = false;
+    this.hasStarted = false;
+    this.apps = [];
+    this.startOptions = {};
+    this.loader = void 0;
+    this.onError = void 0;
+  }
+};
+var microAppManager = new MicroAppManager();
+function setupMicroPluginApps(options) {
+  microAppManager.setup(options);
+}
+function startMicroPluginApps() {
+  microAppManager.start();
+}
+function hasMicroApps() {
+  return microAppManager.hasMicroApps();
+}
+function getMicroApps() {
+  return microAppManager.getApps();
+}
+function hasValidEntry(app) {
+  return typeof app.entry === "string" && app.entry.length > 0;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  MicroAppManager,
+  getMicroApps,
+  hasMicroApps,
+  hasValidEntry,
+  microAppManager,
+  setupMicroPluginApps,
+  startMicroPluginApps
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/setup.ts"],"sourcesContent":["/**\n * x-plugins-micro - 微前端插件\n *\n * 基于 qiankun 的微前端解决方案插件，提供简洁的 API 用于管理微前端应用。\n *\n * @example\n * ```typescript\n * import { setupMicroPluginApps, startMicroPluginApps } from '@maxax/x-plugins-micro'\n *\n * setupMicroPluginApps({\n *   apps: [\n *     {\n *       name: 'micro-app',\n *       entry: 'http://localhost:3000',\n *       activeRule: '/micro',\n *       containerId: 'micro-container',\n *       routeKey: 'micro'\n *     }\n *   ]\n * })\n *\n * // 在适当的时机启动\n * startMicroPluginApps()\n * ```\n *\n * @packageDocumentation\n */\n\n// 导出类型定义\nexport type { MicroAppDescriptor, MicroAppSetupOptions, MicroAppStartOptions } from './types'\n\n// 导出核心功能\nexport { getMicroApps, hasMicroApps, hasValidEntry, MicroAppManager, microAppManager, setupMicroPluginApps, startMicroPluginApps } from './setup'\n","/**\n * 微前端应用设置和启动模块\n * @module setup\n */\n\nimport type { FrameworkConfiguration } from 'qiankun'\nimport { addGlobalUncaughtErrorHandler, registerMicroApps, start } from 'qiankun'\nimport type { MicroAppDescriptor, MicroAppSetupOptions, MicroAppStartOptions } from './types'\n\n/**\n * 微前端管理器类\n * 负责管理微应用的注册、启动和生命周期\n */\nexport class MicroAppManager {\n  /** 是否已注册微应用 */\n  private hasRegistered = false\n\n  /** 是否已启动微前端框架 */\n  private hasStarted = false\n\n  /** 微应用配置列表 */\n  private apps: MicroAppDescriptor[] = []\n\n  /** 启动配置选项 */\n  private startOptions: MicroAppStartOptions = {}\n\n  /** 自定义加载器函数 */\n  private loader?: (loading: boolean) => void\n\n  /** 自定义错误处理函数 */\n  private onError?: (event: Event | string) => void\n\n  /**\n   * 检查是否有有效的微应用配置\n   * @returns 是否存在有效的微应用\n   */\n  hasMicroApps(): boolean {\n    return this.apps.length > 0\n  }\n\n  /**\n   * 过滤出有效的微应用配置（必须有 entry）\n   * @param apps 微应用配置列表\n   * @returns 有效的微应用配置列表\n   */\n  private filterValidApps(apps: MicroAppDescriptor[]): MicroAppDescriptor[] {\n    return apps.filter((app): app is MicroAppDescriptor & { entry: string } => {\n      return typeof app.entry === 'string' && app.entry.length > 0\n    })\n  }\n\n  /**\n   * 设置微前端应用\n   * @param options 设置选项\n   */\n  setup(options: MicroAppSetupOptions): void {\n    if (this.hasRegistered) {\n      console.warn('[x-micro-plugin] 微应用已经注册，跳过重复注册')\n      return\n    }\n\n    // 过滤出有效的微应用配置\n    this.apps = this.filterValidApps(options.apps)\n\n    if (!this.hasMicroApps()) {\n      console.warn('[x-micro-plugin] 没有有效的微应用配置，跳过注册')\n      return\n    }\n\n    // 保存配置选项\n    this.startOptions = options.startOptions || {}\n    this.loader = options.loader\n    this.onError = options.onError\n\n    // 注册微应用\n    this.registerMicroApps()\n\n    // 设置全局错误处理\n    this.setupErrorHandler()\n\n    this.hasRegistered = true\n  }\n\n  /**\n   * 注册微应用到 qiankun\n   */\n  private registerMicroApps(): void {\n    registerMicroApps(\n      this.apps.map(app => ({\n        name: app.name,\n        entry: app.entry!,\n        container: `#${app.containerId}`,\n        activeRule: app.activeRule,\n        props: {\n          ...app.props\n        },\n        loader: (loading: boolean) => {\n          // 调用自定义加载器\n          this.loader?.(loading)\n        }\n      }))\n    )\n  }\n\n  /**\n   * 设置全局错误处理\n   */\n  private setupErrorHandler(): void {\n    addGlobalUncaughtErrorHandler((event: Event | string) => {\n      // 调用自定义错误处理函数\n      if (this.onError) {\n        this.onError(event)\n      } else {\n        // 默认错误处理\n        console.error('[x-micro-plugin] 微应用加载错误', event)\n        // 尝试使用全局消息提示\n        if (typeof window !== 'undefined' && (window as any).$message) {\n          console.error('子应用加载失败，请稍后重试')\n        }\n      }\n    })\n  }\n\n  /**\n   * 启动微前端框架\n   */\n  start(): void {\n    if (!this.hasRegistered) {\n      console.warn('[x-micro-plugin] 微应用尚未注册，请先调用 setup() 方法')\n      return\n    }\n\n    if (this.hasStarted) {\n      console.warn('[x-micro-plugin] 微前端框架已经启动，跳过重复启动')\n      return\n    }\n\n    const startOpts: FrameworkConfiguration = {\n      prefetch: this.startOptions.prefetch !== false, // 默认启用预加载\n      sandbox: {\n        experimentalStyleIsolation: this.startOptions.sandbox?.experimentalStyleIsolation ?? true,\n        strictStyleIsolation: this.startOptions.sandbox?.strictStyleIsolation ?? false,\n        ...this.startOptions.sandbox\n      },\n      ...this.startOptions\n    }\n\n    start(startOpts)\n\n    this.hasStarted = true\n  }\n\n  /**\n   * 获取已注册的微应用配置列表\n   * @returns 微应用配置列表的只读副本\n   */\n  getApps(): ReadonlyArray<MicroAppDescriptor> {\n    return [...this.apps]\n  }\n\n  /**\n   * 重置管理器状态（主要用于测试）\n   */\n  reset(): void {\n    this.hasRegistered = false\n    this.hasStarted = false\n    this.apps = []\n    this.startOptions = {}\n    this.loader = undefined\n    this.onError = undefined\n  }\n}\n\n/**\n * 全局微前端管理器实例\n */\nexport const microAppManager = new MicroAppManager()\n\n/**\n * 设置微前端应用（便捷函数）\n * @param options 设置选项\n */\nexport function setupMicroPluginApps(options: MicroAppSetupOptions): void {\n  microAppManager.setup(options)\n}\n\n/**\n * 启动微前端框架（便捷函数）\n */\nexport function startMicroPluginApps(): void {\n  microAppManager.start()\n}\n\n/**\n * 检查是否有微应用（便捷函数）\n * @returns 是否存在微应用\n */\nexport function hasMicroApps(): boolean {\n  return microAppManager.hasMicroApps()\n}\n\n/**\n * 获取微应用配置列表（便捷函数）\n * @returns 微应用配置列表\n */\nexport function getMicroApps(): ReadonlyArray<MicroAppDescriptor> {\n  return microAppManager.getApps()\n}\n\n/**\n * 类型守卫：检查微应用是否有有效的入口地址\n * @param app 微应用描述符\n * @returns 是否为有效的微应用（有入口地址）\n */\nexport function hasValidEntry(app: MicroAppDescriptor): app is MicroAppDescriptor & { entry: string } {\n  return typeof app.entry === 'string' && app.entry.length > 0\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACMA,qBAAwE;AAOjE,IAAM,kBAAN,MAAsB;AAAA,EAAtB;AAEL;AAAA,wBAAQ,iBAAgB;AAGxB;AAAA,wBAAQ,cAAa;AAGrB;AAAA,wBAAQ,QAA6B,CAAC;AAGtC;AAAA,wBAAQ,gBAAqC,CAAC;AAG9C;AAAA,wBAAQ;AAGR;AAAA,wBAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMR,eAAwB;AACtB,WAAO,KAAK,KAAK,SAAS;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,gBAAgB,MAAkD;AACxE,WAAO,KAAK,OAAO,CAAC,QAAuD;AACzE,aAAO,OAAO,IAAI,UAAU,YAAY,IAAI,MAAM,SAAS;AAAA,IAC7D,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,SAAqC;AACzC,QAAI,KAAK,eAAe;AACtB,cAAQ,KAAK,uGAAiC;AAC9C;AAAA,IACF;AAGA,SAAK,OAAO,KAAK,gBAAgB,QAAQ,IAAI;AAE7C,QAAI,CAAC,KAAK,aAAa,GAAG;AACxB,cAAQ,KAAK,6GAAkC;AAC/C;AAAA,IACF;AAGA,SAAK,eAAe,QAAQ,gBAAgB,CAAC;AAC7C,SAAK,SAAS,QAAQ;AACtB,SAAK,UAAU,QAAQ;AAGvB,SAAK,kBAAkB;AAGvB,SAAK,kBAAkB;AAEvB,SAAK,gBAAgB;AAAA,EACvB;AAAA;AAAA;AAAA;AAAA,EAKQ,oBAA0B;AAChC;AAAA,MACE,KAAK,KAAK,IAAI,UAAQ;AAAA,QACpB,MAAM,IAAI;AAAA,QACV,OAAO,IAAI;AAAA,QACX,WAAW,IAAI,IAAI,WAAW;AAAA,QAC9B,YAAY,IAAI;AAAA,QAChB,OAAO;AAAA,UACL,GAAG,IAAI;AAAA,QACT;AAAA,QACA,QAAQ,CAAC,YAAqB;AAhGtC;AAkGU,qBAAK,WAAL,8BAAc;AAAA,QAChB;AAAA,MACF,EAAE;AAAA,IACJ;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKQ,oBAA0B;AAChC,sDAA8B,CAAC,UAA0B;AAEvD,UAAI,KAAK,SAAS;AAChB,aAAK,QAAQ,KAAK;AAAA,MACpB,OAAO;AAEL,gBAAQ,MAAM,+DAA4B,KAAK;AAE/C,YAAI,OAAO,WAAW,eAAgB,OAAe,UAAU;AAC7D,kBAAQ,MAAM,gFAAe;AAAA,QAC/B;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA,EAKA,QAAc;AA9HhB;AA+HI,QAAI,CAAC,KAAK,eAAe;AACvB,cAAQ,KAAK,gHAA0C;AACvD;AAAA,IACF;AAEA,QAAI,KAAK,YAAY;AACnB,cAAQ,KAAK,mHAAmC;AAChD;AAAA,IACF;AAEA,UAAM,YAAoC;AAAA,MACxC,UAAU,KAAK,aAAa,aAAa;AAAA;AAAA,MACzC,SAAS;AAAA,QACP,6BAA4B,gBAAK,aAAa,YAAlB,mBAA2B,+BAA3B,YAAyD;AAAA,QACrF,uBAAsB,gBAAK,aAAa,YAAlB,mBAA2B,yBAA3B,YAAmD;AAAA,QACzE,GAAG,KAAK,aAAa;AAAA,MACvB;AAAA,MACA,GAAG,KAAK;AAAA,IACV;AAEA,8BAAM,SAAS;AAEf,SAAK,aAAa;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAA6C;AAC3C,WAAO,CAAC,GAAG,KAAK,IAAI;AAAA,EACtB;AAAA;AAAA;AAAA;AAAA,EAKA,QAAc;AACZ,SAAK,gBAAgB;AACrB,SAAK,aAAa;AAClB,SAAK,OAAO,CAAC;AACb,SAAK,eAAe,CAAC;AACrB,SAAK,SAAS;AACd,SAAK,UAAU;AAAA,EACjB;AACF;AAKO,IAAM,kBAAkB,IAAI,gBAAgB;AAM5C,SAAS,qBAAqB,SAAqC;AACxE,kBAAgB,MAAM,OAAO;AAC/B;AAKO,SAAS,uBAA6B;AAC3C,kBAAgB,MAAM;AACxB;AAMO,SAAS,eAAwB;AACtC,SAAO,gBAAgB,aAAa;AACtC;AAMO,SAAS,eAAkD;AAChE,SAAO,gBAAgB,QAAQ;AACjC;AAOO,SAAS,cAAc,KAAwE;AACpG,SAAO,OAAO,IAAI,UAAU,YAAY,IAAI,MAAM,SAAS;AAC7D;","names":[]}

package/dist/index.d.cts

@@ -0,0 +1,145 @@
+/**
+ * 微前端应用描述符类型定义
+ * @module types
+ */
+/**
+ * 微应用描述符接口
+ * 用于定义单个微前端应用的配置信息
+ */
+interface MicroAppDescriptor {
+    /** Qiankun 微应用名称，必须唯一 */
+    name: string;
+    /** 微应用入口地址 URL，可以是相对路径或绝对路径 */
+    entry?: string;
+    /** Qiankun 激活规则，可以是字符串路径或函数 */
+    activeRule: string | ((location: Location) => boolean);
+    /** 挂载微应用的容器 DOM 元素 ID */
+    containerId: string;
+    /** 绑定的路由键，用于路由匹配 */
+    routeKey: string;
+    /** 传递给微应用的额外属性 */
+    props?: Record<string, unknown>;
+}
+/**
+ * 微前端启动配置选项
+ */
+interface MicroAppStartOptions {
+    /** 是否启用预加载，默认 true */
+    prefetch?: boolean;
+    /** 沙箱配置 */
+    sandbox?: {
+        /** 是否启用实验性的样式隔离 */
+        experimentalStyleIsolation?: boolean;
+        /** 是否启用严格样式隔离 */
+        strictStyleIsolation?: boolean;
+    };
+    /** 其他 qiankun start 选项 */
+    [key: string]: unknown;
+}
+/**
+ * 微前端设置选项
+ */
+interface MicroAppSetupOptions {
+    /** 微应用配置列表 */
+    apps: MicroAppDescriptor[];
+    /** 启动配置选项 */
+    startOptions?: MicroAppStartOptions;
+    /** 自定义加载器函数，用于处理加载状态 */
+    loader?: (loading: boolean) => void;
+    /** 自定义错误处理函数 */
+    onError?: (event: Event | string) => void;
+}
+
+/**
+ * 微前端应用设置和启动模块
+ * @module setup
+ */
+
+/**
+ * 微前端管理器类
+ * 负责管理微应用的注册、启动和生命周期
+ */
+declare class MicroAppManager {
+    /** 是否已注册微应用 */
+    private hasRegistered;
+    /** 是否已启动微前端框架 */
+    private hasStarted;
+    /** 微应用配置列表 */
+    private apps;
+    /** 启动配置选项 */
+    private startOptions;
+    /** 自定义加载器函数 */
+    private loader?;
+    /** 自定义错误处理函数 */
+    private onError?;
+    /**
+     * 检查是否有有效的微应用配置
+     * @returns 是否存在有效的微应用
+     */
+    hasMicroApps(): boolean;
+    /**
+     * 过滤出有效的微应用配置（必须有 entry）
+     * @param apps 微应用配置列表
+     * @returns 有效的微应用配置列表
+     */
+    private filterValidApps;
+    /**
+     * 设置微前端应用
+     * @param options 设置选项
+     */
+    setup(options: MicroAppSetupOptions): void;
+    /**
+     * 注册微应用到 qiankun
+     */
+    private registerMicroApps;
+    /**
+     * 设置全局错误处理
+     */
+    private setupErrorHandler;
+    /**
+     * 启动微前端框架
+     */
+    start(): void;
+    /**
+     * 获取已注册的微应用配置列表
+     * @returns 微应用配置列表的只读副本
+     */
+    getApps(): ReadonlyArray<MicroAppDescriptor>;
+    /**
+     * 重置管理器状态（主要用于测试）
+     */
+    reset(): void;
+}
+/**
+ * 全局微前端管理器实例
+ */
+declare const microAppManager: MicroAppManager;
+/**
+ * 设置微前端应用（便捷函数）
+ * @param options 设置选项
+ */
+declare function setupMicroPluginApps(options: MicroAppSetupOptions): void;
+/**
+ * 启动微前端框架（便捷函数）
+ */
+declare function startMicroPluginApps(): void;
+/**
+ * 检查是否有微应用（便捷函数）
+ * @returns 是否存在微应用
+ */
+declare function hasMicroApps(): boolean;
+/**
+ * 获取微应用配置列表（便捷函数）
+ * @returns 微应用配置列表
+ */
+declare function getMicroApps(): ReadonlyArray<MicroAppDescriptor>;
+/**
+ * 类型守卫：检查微应用是否有有效的入口地址
+ * @param app 微应用描述符
+ * @returns 是否为有效的微应用（有入口地址）
+ */
+declare function hasValidEntry(app: MicroAppDescriptor): app is MicroAppDescriptor & {
+    entry: string;
+};
+
+export { type MicroAppDescriptor, MicroAppManager, type MicroAppSetupOptions, type MicroAppStartOptions, getMicroApps, hasMicroApps, hasValidEntry, microAppManager, setupMicroPluginApps, startMicroPluginApps };

package/dist/index.d.ts

@@ -0,0 +1,145 @@
+/**
+ * 微前端应用描述符类型定义
+ * @module types
+ */
+/**
+ * 微应用描述符接口
+ * 用于定义单个微前端应用的配置信息
+ */
+interface MicroAppDescriptor {
+    /** Qiankun 微应用名称，必须唯一 */
+    name: string;
+    /** 微应用入口地址 URL，可以是相对路径或绝对路径 */
+    entry?: string;
+    /** Qiankun 激活规则，可以是字符串路径或函数 */
+    activeRule: string | ((location: Location) => boolean);
+    /** 挂载微应用的容器 DOM 元素 ID */
+    containerId: string;
+    /** 绑定的路由键，用于路由匹配 */
+    routeKey: string;
+    /** 传递给微应用的额外属性 */
+    props?: Record<string, unknown>;
+}
+/**
+ * 微前端启动配置选项
+ */
+interface MicroAppStartOptions {
+    /** 是否启用预加载，默认 true */
+    prefetch?: boolean;
+    /** 沙箱配置 */
+    sandbox?: {
+        /** 是否启用实验性的样式隔离 */
+        experimentalStyleIsolation?: boolean;
+        /** 是否启用严格样式隔离 */
+        strictStyleIsolation?: boolean;
+    };
+    /** 其他 qiankun start 选项 */
+    [key: string]: unknown;
+}
+/**
+ * 微前端设置选项
+ */
+interface MicroAppSetupOptions {
+    /** 微应用配置列表 */
+    apps: MicroAppDescriptor[];
+    /** 启动配置选项 */
+    startOptions?: MicroAppStartOptions;
+    /** 自定义加载器函数，用于处理加载状态 */
+    loader?: (loading: boolean) => void;
+    /** 自定义错误处理函数 */
+    onError?: (event: Event | string) => void;
+}
+
+/**
+ * 微前端应用设置和启动模块
+ * @module setup
+ */
+
+/**
+ * 微前端管理器类
+ * 负责管理微应用的注册、启动和生命周期
+ */
+declare class MicroAppManager {
+    /** 是否已注册微应用 */
+    private hasRegistered;
+    /** 是否已启动微前端框架 */
+    private hasStarted;
+    /** 微应用配置列表 */
+    private apps;
+    /** 启动配置选项 */
+    private startOptions;
+    /** 自定义加载器函数 */
+    private loader?;
+    /** 自定义错误处理函数 */
+    private onError?;
+    /**
+     * 检查是否有有效的微应用配置
+     * @returns 是否存在有效的微应用
+     */
+    hasMicroApps(): boolean;
+    /**
+     * 过滤出有效的微应用配置（必须有 entry）
+     * @param apps 微应用配置列表
+     * @returns 有效的微应用配置列表
+     */
+    private filterValidApps;
+    /**
+     * 设置微前端应用
+     * @param options 设置选项
+     */
+    setup(options: MicroAppSetupOptions): void;
+    /**
+     * 注册微应用到 qiankun
+     */
+    private registerMicroApps;
+    /**
+     * 设置全局错误处理
+     */
+    private setupErrorHandler;
+    /**
+     * 启动微前端框架
+     */
+    start(): void;
+    /**
+     * 获取已注册的微应用配置列表
+     * @returns 微应用配置列表的只读副本
+     */
+    getApps(): ReadonlyArray<MicroAppDescriptor>;
+    /**
+     * 重置管理器状态（主要用于测试）
+     */
+    reset(): void;
+}
+/**
+ * 全局微前端管理器实例
+ */
+declare const microAppManager: MicroAppManager;
+/**
+ * 设置微前端应用（便捷函数）
+ * @param options 设置选项
+ */
+declare function setupMicroPluginApps(options: MicroAppSetupOptions): void;
+/**
+ * 启动微前端框架（便捷函数）
+ */
+declare function startMicroPluginApps(): void;
+/**
+ * 检查是否有微应用（便捷函数）
+ * @returns 是否存在微应用
+ */
+declare function hasMicroApps(): boolean;
+/**
+ * 获取微应用配置列表（便捷函数）
+ * @returns 微应用配置列表
+ */
+declare function getMicroApps(): ReadonlyArray<MicroAppDescriptor>;
+/**
+ * 类型守卫：检查微应用是否有有效的入口地址
+ * @param app 微应用描述符
+ * @returns 是否为有效的微应用（有入口地址）
+ */
+declare function hasValidEntry(app: MicroAppDescriptor): app is MicroAppDescriptor & {
+    entry: string;
+};
+
+export { type MicroAppDescriptor, MicroAppManager, type MicroAppSetupOptions, type MicroAppStartOptions, getMicroApps, hasMicroApps, hasValidEntry, microAppManager, setupMicroPluginApps, startMicroPluginApps };

package/dist/index.mjs

@@ -0,0 +1,165 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+
+// src/setup.ts
+import { addGlobalUncaughtErrorHandler, registerMicroApps, start } from "qiankun";
+var MicroAppManager = class {
+  constructor() {
+    /** 是否已注册微应用 */
+    __publicField(this, "hasRegistered", false);
+    /** 是否已启动微前端框架 */
+    __publicField(this, "hasStarted", false);
+    /** 微应用配置列表 */
+    __publicField(this, "apps", []);
+    /** 启动配置选项 */
+    __publicField(this, "startOptions", {});
+    /** 自定义加载器函数 */
+    __publicField(this, "loader");
+    /** 自定义错误处理函数 */
+    __publicField(this, "onError");
+  }
+  /**
+   * 检查是否有有效的微应用配置
+   * @returns 是否存在有效的微应用
+   */
+  hasMicroApps() {
+    return this.apps.length > 0;
+  }
+  /**
+   * 过滤出有效的微应用配置（必须有 entry）
+   * @param apps 微应用配置列表
+   * @returns 有效的微应用配置列表
+   */
+  filterValidApps(apps) {
+    return apps.filter((app) => {
+      return typeof app.entry === "string" && app.entry.length > 0;
+    });
+  }
+  /**
+   * 设置微前端应用
+   * @param options 设置选项
+   */
+  setup(options) {
+    if (this.hasRegistered) {
+      console.warn("[x-micro-plugin] \u5FAE\u5E94\u7528\u5DF2\u7ECF\u6CE8\u518C\uFF0C\u8DF3\u8FC7\u91CD\u590D\u6CE8\u518C");
+      return;
+    }
+    this.apps = this.filterValidApps(options.apps);
+    if (!this.hasMicroApps()) {
+      console.warn("[x-micro-plugin] \u6CA1\u6709\u6709\u6548\u7684\u5FAE\u5E94\u7528\u914D\u7F6E\uFF0C\u8DF3\u8FC7\u6CE8\u518C");
+      return;
+    }
+    this.startOptions = options.startOptions || {};
+    this.loader = options.loader;
+    this.onError = options.onError;
+    this.registerMicroApps();
+    this.setupErrorHandler();
+    this.hasRegistered = true;
+  }
+  /**
+   * 注册微应用到 qiankun
+   */
+  registerMicroApps() {
+    registerMicroApps(
+      this.apps.map((app) => ({
+        name: app.name,
+        entry: app.entry,
+        container: `#${app.containerId}`,
+        activeRule: app.activeRule,
+        props: {
+          ...app.props
+        },
+        loader: (loading) => {
+          var _a;
+          (_a = this.loader) == null ? void 0 : _a.call(this, loading);
+        }
+      }))
+    );
+  }
+  /**
+   * 设置全局错误处理
+   */
+  setupErrorHandler() {
+    addGlobalUncaughtErrorHandler((event) => {
+      if (this.onError) {
+        this.onError(event);
+      } else {
+        console.error("[x-micro-plugin] \u5FAE\u5E94\u7528\u52A0\u8F7D\u9519\u8BEF", event);
+        if (typeof window !== "undefined" && window.$message) {
+          console.error("\u5B50\u5E94\u7528\u52A0\u8F7D\u5931\u8D25\uFF0C\u8BF7\u7A0D\u540E\u91CD\u8BD5");
+        }
+      }
+    });
+  }
+  /**
+   * 启动微前端框架
+   */
+  start() {
+    var _a, _b, _c, _d;
+    if (!this.hasRegistered) {
+      console.warn("[x-micro-plugin] \u5FAE\u5E94\u7528\u5C1A\u672A\u6CE8\u518C\uFF0C\u8BF7\u5148\u8C03\u7528 setup() \u65B9\u6CD5");
+      return;
+    }
+    if (this.hasStarted) {
+      console.warn("[x-micro-plugin] \u5FAE\u524D\u7AEF\u6846\u67B6\u5DF2\u7ECF\u542F\u52A8\uFF0C\u8DF3\u8FC7\u91CD\u590D\u542F\u52A8");
+      return;
+    }
+    const startOpts = {
+      prefetch: this.startOptions.prefetch !== false,
+      // 默认启用预加载
+      sandbox: {
+        experimentalStyleIsolation: (_b = (_a = this.startOptions.sandbox) == null ? void 0 : _a.experimentalStyleIsolation) != null ? _b : true,
+        strictStyleIsolation: (_d = (_c = this.startOptions.sandbox) == null ? void 0 : _c.strictStyleIsolation) != null ? _d : false,
+        ...this.startOptions.sandbox
+      },
+      ...this.startOptions
+    };
+    start(startOpts);
+    this.hasStarted = true;
+  }
+  /**
+   * 获取已注册的微应用配置列表
+   * @returns 微应用配置列表的只读副本
+   */
+  getApps() {
+    return [...this.apps];
+  }
+  /**
+   * 重置管理器状态（主要用于测试）
+   */
+  reset() {
+    this.hasRegistered = false;
+    this.hasStarted = false;
+    this.apps = [];
+    this.startOptions = {};
+    this.loader = void 0;
+    this.onError = void 0;
+  }
+};
+var microAppManager = new MicroAppManager();
+function setupMicroPluginApps(options) {
+  microAppManager.setup(options);
+}
+function startMicroPluginApps() {
+  microAppManager.start();
+}
+function hasMicroApps() {
+  return microAppManager.hasMicroApps();
+}
+function getMicroApps() {
+  return microAppManager.getApps();
+}
+function hasValidEntry(app) {
+  return typeof app.entry === "string" && app.entry.length > 0;
+}
+export {
+  MicroAppManager,
+  getMicroApps,
+  hasMicroApps,
+  hasValidEntry,
+  microAppManager,
+  setupMicroPluginApps,
+  startMicroPluginApps
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/setup.ts"],"sourcesContent":["/**\n * 微前端应用设置和启动模块\n * @module setup\n */\n\nimport type { FrameworkConfiguration } from 'qiankun'\nimport { addGlobalUncaughtErrorHandler, registerMicroApps, start } from 'qiankun'\nimport type { MicroAppDescriptor, MicroAppSetupOptions, MicroAppStartOptions } from './types'\n\n/**\n * 微前端管理器类\n * 负责管理微应用的注册、启动和生命周期\n */\nexport class MicroAppManager {\n  /** 是否已注册微应用 */\n  private hasRegistered = false\n\n  /** 是否已启动微前端框架 */\n  private hasStarted = false\n\n  /** 微应用配置列表 */\n  private apps: MicroAppDescriptor[] = []\n\n  /** 启动配置选项 */\n  private startOptions: MicroAppStartOptions = {}\n\n  /** 自定义加载器函数 */\n  private loader?: (loading: boolean) => void\n\n  /** 自定义错误处理函数 */\n  private onError?: (event: Event | string) => void\n\n  /**\n   * 检查是否有有效的微应用配置\n   * @returns 是否存在有效的微应用\n   */\n  hasMicroApps(): boolean {\n    return this.apps.length > 0\n  }\n\n  /**\n   * 过滤出有效的微应用配置（必须有 entry）\n   * @param apps 微应用配置列表\n   * @returns 有效的微应用配置列表\n   */\n  private filterValidApps(apps: MicroAppDescriptor[]): MicroAppDescriptor[] {\n    return apps.filter((app): app is MicroAppDescriptor & { entry: string } => {\n      return typeof app.entry === 'string' && app.entry.length > 0\n    })\n  }\n\n  /**\n   * 设置微前端应用\n   * @param options 设置选项\n   */\n  setup(options: MicroAppSetupOptions): void {\n    if (this.hasRegistered) {\n      console.warn('[x-micro-plugin] 微应用已经注册，跳过重复注册')\n      return\n    }\n\n    // 过滤出有效的微应用配置\n    this.apps = this.filterValidApps(options.apps)\n\n    if (!this.hasMicroApps()) {\n      console.warn('[x-micro-plugin] 没有有效的微应用配置，跳过注册')\n      return\n    }\n\n    // 保存配置选项\n    this.startOptions = options.startOptions || {}\n    this.loader = options.loader\n    this.onError = options.onError\n\n    // 注册微应用\n    this.registerMicroApps()\n\n    // 设置全局错误处理\n    this.setupErrorHandler()\n\n    this.hasRegistered = true\n  }\n\n  /**\n   * 注册微应用到 qiankun\n   */\n  private registerMicroApps(): void {\n    registerMicroApps(\n      this.apps.map(app => ({\n        name: app.name,\n        entry: app.entry!,\n        container: `#${app.containerId}`,\n        activeRule: app.activeRule,\n        props: {\n          ...app.props\n        },\n        loader: (loading: boolean) => {\n          // 调用自定义加载器\n          this.loader?.(loading)\n        }\n      }))\n    )\n  }\n\n  /**\n   * 设置全局错误处理\n   */\n  private setupErrorHandler(): void {\n    addGlobalUncaughtErrorHandler((event: Event | string) => {\n      // 调用自定义错误处理函数\n      if (this.onError) {\n        this.onError(event)\n      } else {\n        // 默认错误处理\n        console.error('[x-micro-plugin] 微应用加载错误', event)\n        // 尝试使用全局消息提示\n        if (typeof window !== 'undefined' && (window as any).$message) {\n          console.error('子应用加载失败，请稍后重试')\n        }\n      }\n    })\n  }\n\n  /**\n   * 启动微前端框架\n   */\n  start(): void {\n    if (!this.hasRegistered) {\n      console.warn('[x-micro-plugin] 微应用尚未注册，请先调用 setup() 方法')\n      return\n    }\n\n    if (this.hasStarted) {\n      console.warn('[x-micro-plugin] 微前端框架已经启动，跳过重复启动')\n      return\n    }\n\n    const startOpts: FrameworkConfiguration = {\n      prefetch: this.startOptions.prefetch !== false, // 默认启用预加载\n      sandbox: {\n        experimentalStyleIsolation: this.startOptions.sandbox?.experimentalStyleIsolation ?? true,\n        strictStyleIsolation: this.startOptions.sandbox?.strictStyleIsolation ?? false,\n        ...this.startOptions.sandbox\n      },\n      ...this.startOptions\n    }\n\n    start(startOpts)\n\n    this.hasStarted = true\n  }\n\n  /**\n   * 获取已注册的微应用配置列表\n   * @returns 微应用配置列表的只读副本\n   */\n  getApps(): ReadonlyArray<MicroAppDescriptor> {\n    return [...this.apps]\n  }\n\n  /**\n   * 重置管理器状态（主要用于测试）\n   */\n  reset(): void {\n    this.hasRegistered = false\n    this.hasStarted = false\n    this.apps = []\n    this.startOptions = {}\n    this.loader = undefined\n    this.onError = undefined\n  }\n}\n\n/**\n * 全局微前端管理器实例\n */\nexport const microAppManager = new MicroAppManager()\n\n/**\n * 设置微前端应用（便捷函数）\n * @param options 设置选项\n */\nexport function setupMicroPluginApps(options: MicroAppSetupOptions): void {\n  microAppManager.setup(options)\n}\n\n/**\n * 启动微前端框架（便捷函数）\n */\nexport function startMicroPluginApps(): void {\n  microAppManager.start()\n}\n\n/**\n * 检查是否有微应用（便捷函数）\n * @returns 是否存在微应用\n */\nexport function hasMicroApps(): boolean {\n  return microAppManager.hasMicroApps()\n}\n\n/**\n * 获取微应用配置列表（便捷函数）\n * @returns 微应用配置列表\n */\nexport function getMicroApps(): ReadonlyArray<MicroAppDescriptor> {\n  return microAppManager.getApps()\n}\n\n/**\n * 类型守卫：检查微应用是否有有效的入口地址\n * @param app 微应用描述符\n * @returns 是否为有效的微应用（有入口地址）\n */\nexport function hasValidEntry(app: MicroAppDescriptor): app is MicroAppDescriptor & { entry: string } {\n  return typeof app.entry === 'string' && app.entry.length > 0\n}\n"],"mappings":";;;;;AAMA,SAAS,+BAA+B,mBAAmB,aAAa;AAOjE,IAAM,kBAAN,MAAsB;AAAA,EAAtB;AAEL;AAAA,wBAAQ,iBAAgB;AAGxB;AAAA,wBAAQ,cAAa;AAGrB;AAAA,wBAAQ,QAA6B,CAAC;AAGtC;AAAA,wBAAQ,gBAAqC,CAAC;AAG9C;AAAA,wBAAQ;AAGR;AAAA,wBAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMR,eAAwB;AACtB,WAAO,KAAK,KAAK,SAAS;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,gBAAgB,MAAkD;AACxE,WAAO,KAAK,OAAO,CAAC,QAAuD;AACzE,aAAO,OAAO,IAAI,UAAU,YAAY,IAAI,MAAM,SAAS;AAAA,IAC7D,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,SAAqC;AACzC,QAAI,KAAK,eAAe;AACtB,cAAQ,KAAK,uGAAiC;AAC9C;AAAA,IACF;AAGA,SAAK,OAAO,KAAK,gBAAgB,QAAQ,IAAI;AAE7C,QAAI,CAAC,KAAK,aAAa,GAAG;AACxB,cAAQ,KAAK,6GAAkC;AAC/C;AAAA,IACF;AAGA,SAAK,eAAe,QAAQ,gBAAgB,CAAC;AAC7C,SAAK,SAAS,QAAQ;AACtB,SAAK,UAAU,QAAQ;AAGvB,SAAK,kBAAkB;AAGvB,SAAK,kBAAkB;AAEvB,SAAK,gBAAgB;AAAA,EACvB;AAAA;AAAA;AAAA;AAAA,EAKQ,oBAA0B;AAChC;AAAA,MACE,KAAK,KAAK,IAAI,UAAQ;AAAA,QACpB,MAAM,IAAI;AAAA,QACV,OAAO,IAAI;AAAA,QACX,WAAW,IAAI,IAAI,WAAW;AAAA,QAC9B,YAAY,IAAI;AAAA,QAChB,OAAO;AAAA,UACL,GAAG,IAAI;AAAA,QACT;AAAA,QACA,QAAQ,CAAC,YAAqB;AAhGtC;AAkGU,qBAAK,WAAL,8BAAc;AAAA,QAChB;AAAA,MACF,EAAE;AAAA,IACJ;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKQ,oBAA0B;AAChC,kCAA8B,CAAC,UAA0B;AAEvD,UAAI,KAAK,SAAS;AAChB,aAAK,QAAQ,KAAK;AAAA,MACpB,OAAO;AAEL,gBAAQ,MAAM,+DAA4B,KAAK;AAE/C,YAAI,OAAO,WAAW,eAAgB,OAAe,UAAU;AAC7D,kBAAQ,MAAM,gFAAe;AAAA,QAC/B;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA,EAKA,QAAc;AA9HhB;AA+HI,QAAI,CAAC,KAAK,eAAe;AACvB,cAAQ,KAAK,gHAA0C;AACvD;AAAA,IACF;AAEA,QAAI,KAAK,YAAY;AACnB,cAAQ,KAAK,mHAAmC;AAChD;AAAA,IACF;AAEA,UAAM,YAAoC;AAAA,MACxC,UAAU,KAAK,aAAa,aAAa;AAAA;AAAA,MACzC,SAAS;AAAA,QACP,6BAA4B,gBAAK,aAAa,YAAlB,mBAA2B,+BAA3B,YAAyD;AAAA,QACrF,uBAAsB,gBAAK,aAAa,YAAlB,mBAA2B,yBAA3B,YAAmD;AAAA,QACzE,GAAG,KAAK,aAAa;AAAA,MACvB;AAAA,MACA,GAAG,KAAK;AAAA,IACV;AAEA,UAAM,SAAS;AAEf,SAAK,aAAa;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAA6C;AAC3C,WAAO,CAAC,GAAG,KAAK,IAAI;AAAA,EACtB;AAAA;AAAA;AAAA;AAAA,EAKA,QAAc;AACZ,SAAK,gBAAgB;AACrB,SAAK,aAAa;AAClB,SAAK,OAAO,CAAC;AACb,SAAK,eAAe,CAAC;AACrB,SAAK,SAAS;AACd,SAAK,UAAU;AAAA,EACjB;AACF;AAKO,IAAM,kBAAkB,IAAI,gBAAgB;AAM5C,SAAS,qBAAqB,SAAqC;AACxE,kBAAgB,MAAM,OAAO;AAC/B;AAKO,SAAS,uBAA6B;AAC3C,kBAAgB,MAAM;AACxB;AAMO,SAAS,eAAwB;AACtC,SAAO,gBAAgB,aAAa;AACtC;AAMO,SAAS,eAAkD;AAChE,SAAO,gBAAgB,QAAQ;AACjC;AAOO,SAAS,cAAc,KAAwE;AACpG,SAAO,OAAO,IAAI,UAAU,YAAY,IAAI,MAAM,SAAS;AAC7D;","names":[]}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@maxax/x-plugins-micro",
+  "version": "1.0.0",
+  "description": "Reusable micro-frontend plugin based on qiankun for Maxax projects",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "keywords": [
+    "micro-frontend",
+    "qiankun",
+    "micro-app",
+    "maxax"
+  ],
+  "license": "MIT",
+  "peerDependencies": {
+    "qiankun": "^2.10.0"
+  },
+  "devDependencies": {
+    "qiankun": "^2.10.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "clean": "rm -rf dist"
+  }
+}