@skyfox2000/microbase 1.0.0

package/src/index.ts

@@ -0,0 +1,14 @@
+export * from "@/stores/appInfo.d";
+export * from "@/stores/hostInfo.d";
+export * from "@/stores/settingInfo.d";
+export * from "@/stores/userInfo.d";
+
+
+export * from "@/utils/data";
+export * from "@/utils/micro-app";
+
+export * from "@/router/loader-router";
+import LoaderRouter from "@/router/loader-router";
+export { LoaderRouter };
+
+export * from "@/components/loader/index";

package/src/router/loader-router.ts

@@ -0,0 +1,153 @@
+import { mainAppApis } from "@/utils/micro-app";
+import {
+   RouteLocationNormalizedGeneric,
+   RouteRecordRaw,
+   Router,
+   createRouter,
+   createWebHashHistory
+} from "vue-router";
+
+/**
+ * 菜单链接信息
+ */
+export type MenuLink = {
+   /**
+    * 名称
+    */
+   name: string;
+   /**
+    * 图标
+    * icon可以是字符串路径或组件
+    */
+   icon: string;
+   /**
+    * 路径
+    */
+   path: string;
+   [key: string]: any;
+};
+
+/**
+ * 路由扩展信息
+ */
+export type RouteMeta = {
+   /**
+    * 应用码，所属应用
+    */
+   code?: string | null;
+   /**
+    * 应用地址
+    */
+   host?: string | null;
+   /**
+    * 页面地址
+    */
+   page?: string | null;
+   /**
+    * 授权角色
+    */
+   roles?: string[];
+   /**
+    * 功能码
+    */
+   permission?: string;
+};
+
+/**
+ * 路由记录
+ */
+export type RouteRecord = RouteRecordRaw & {
+   parent?: RouteRecord | null;
+   /**
+    * 路由图标
+    */
+   icon?: string;
+   /**
+    * 附加属性
+    */
+   meta?: RouteMeta;
+   /**
+    * 子路由信息
+    */
+   children?: RouteRecord[];
+};
+
+/**
+ * 默认路由
+ */
+const routes: RouteRecordRaw[] = [
+   {
+      path: "/:page(.*)",
+      name: "默认页面",
+      component: () => import("@/components/loader/index.vue")
+   }
+];
+
+const router: Router = createRouter({
+   history: createWebHashHistory(import.meta.env.VITE_ROUTER_BASE),
+   routes: routes
+});
+
+/**
+ * 路由权限判断
+ * @param route 指定路由
+ * @param isLogin 是否已登录
+ * @param userRoles 用户角色
+ * @param userPermits 用户权限
+ * @returns 权限判断结果
+ */
+export const hasPermission = (
+   route: RouteRecord,
+   isLogin: boolean,
+   userRoles: string[],
+   userPermits: string[]
+): boolean => {
+   const roles = route.meta?.roles ?? [];
+   const permission = route.meta?.permission;
+
+   // 如果用户未登录，且路由没有角色和权限要求，则允许访问
+   if (!isLogin) {
+      return roles.length === 0 && !permission;
+   }
+
+   // 如果用户已登录或有角色和权限信息
+   if (isLogin && (userRoles.length > 0 || userPermits.length > 0)) {
+      // 没有角色码和权限码，都可以访问
+      if (roles.length === 0 && !permission) {
+         return true;
+      }
+
+      // 路由有角色码无权限码，符合任何一个角色都可以访问
+      if (roles.length && !permission) {
+         return roles.some((role) => userRoles.includes(role));
+      }
+
+      // 路由无角色码有权限码，符合权限码即可访问
+      if (!roles.length && permission) {
+         return userPermits.includes(permission);
+      }
+
+      // 路由同时有角色码和权限码，必须用户角色和权限同时满足才可访问
+      if (roles.length && permission) {
+         return (
+            roles.some((role) => userRoles.includes(role)) &&
+            userPermits.includes(permission)
+         );
+      }
+   }
+
+   // 默认返回 false，即无匹配条件时不允许访问
+   return false;
+};
+
+/**
+ * 子应用更新主应用路由
+ */
+router.afterEach((to: RouteLocationNormalizedGeneric) => {
+   if (mainAppApis.value) {
+      const { mainAppPush } = mainAppApis.value;
+      if(mainAppPush) mainAppPush(to.hash);
+   }
+});
+
+export default router;

package/src/stores/appInfo.d.ts

@@ -0,0 +1,95 @@
+/**
+ * 应用来源： Market | Manual
+ */
+export enum AppSource {
+   /**
+    * 从市场安装
+    */
+   "Market" = "Market",
+   /**
+    * 手动输入
+    */
+   "Manual" = "Manual"
+}
+/**
+ * 应用动作： App | Open | Iframe
+ */
+export enum AppAction {
+   /**
+    * 应用模式加载
+    */
+   "App" = "App",
+   /**
+    * 托管应用模式加载
+    * - 菜单托管，平台管理加载菜单
+    */
+   "MenuApp" = "MenuApp",
+   /**
+    * 链接，弹出窗口打开
+    */
+   "Link" = "Link",
+   /**
+    * Iframe内嵌方式打开
+    */
+   "Iframe" = "Iframe"
+}
+/**
+ * 应用信息
+ */
+export interface AppInfo {
+   /**
+    * 主键
+    */
+   Id: string;
+   /**
+    * 名称
+    */
+   Name: string;
+   /**
+    * 唯一编码
+    * - 路由前缀地址
+    */
+   AppCode: string;
+   /**
+    * 版本号
+    */
+   Version: string;
+   /**
+    * 图标
+    */
+   Icon: string;
+   /**
+    * 来源： Market | Manual
+    */
+   Source: AppSource;
+   /**
+    * 动作: App | MenuApp | Open | Iframe
+    */
+   Action: AppAction;
+   /**
+    * 应用加载地址
+    * - http开头地址
+    * - SERVER_HOST配置
+    */
+   Host: string;
+   /**
+    * 默认页面
+    */
+   Page?: string;
+   /**
+    * 默认应用，如没设置，则使用第一个
+    */
+   Default?: boolean;
+   /**
+    * 描述
+    */
+   Description?: string;
+
+   /**
+    * 启用状态
+    * - 启用 true 1
+    * - 停用 false 0
+    */
+   Enabled: boolean | number;
+   [key: string]: any;
+}

package/src/stores/hostInfo.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 启动配置信息
+ * - 网站配置信息
+ * - 前端初始配置
+ */
+export interface HostInfo {
+   /**
+    * 网站地址，配置码
+    */
+   Host: string;
+   /**
+    * 短名称
+    */
+   Title: string;
+   /**
+    * 网站全名称
+    */
+   FullTitle?: string;
+   /**
+    * Logo图标地址
+    */
+   LogoIcon?: string;
+   /**
+    * 登录页面地址
+    */
+   LoginUrl?: string;
+   /**
+    * 用户信息页面地址
+    */
+   UserSettingUrl?: string;
+   /**
+    * 服务商名称
+    */
+   Provider?: string;
+   /**
+    * 接口域名地址
+    */
+   API_HOST?: {
+      [key: string]: string;
+   } | null;
+   /**
+    * 网站服务器地址
+    */
+   SERVER_HOST?: Record<string, string>;
+   /**
+    * 扩展属性配置
+    */
+   ExtraPropLines?: Record<string, any>[];
+   /**
+    * 扩展属性
+    */
+   ExtraProps?: {
+      [key: string]: string;
+   };
+   [key: string]: any;
+}

package/src/stores/settingInfo.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 表格行操作区位置
+ */
+export enum RowOperate {
+   LEFT = 1,
+   RIGHT = 2
+}
+/**
+ * 前端个性化配置
+ */
+export interface SettingInfo {
+   /**
+    * 全屏显示
+    */
+   readonly fullscreen: boolean;
+   /**
+    * 主菜单区折叠
+    */
+   readonly menuCollapse: boolean;
+   /**
+    * 表格行操作区位置
+    */
+   readonly rowOperate: RowOperate;
+   /**
+    * 使用语言
+    */
+   readonly language?: string;
+   /**
+    * 主题模式
+    */
+   readonly theme?: string;
+   /**
+    * 主题颜色
+    */
+   readonly themeColor?: string;
+}

package/src/stores/userInfo.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 用户信息
+ */
+export interface UserInfo {
+   /**
+    * 主键
+    */
+   Id: string;
+   /**
+    * 名称
+    */
+   Name: string;
+   /**
+    * 用户码
+    */
+   Code: string;
+   /**
+    * 角色
+    */
+   Roles: string[];
+   /**
+    * 权限
+    */
+   Permissions: string[];
+}
+
+/**
+ * 登录信息与授权
+ */
+export interface LoginInfo {
+   /**
+    * 用户名
+    */
+   UserName: string;
+   /**
+    * 密码
+    */
+   UserPass: string;
+   /**
+    * 登录返回的用户信息
+    */
+   UserInfo?: UserInfo;
+   /**
+    * 登录获取的授权token
+    */
+   token?: string;
+   /**
+    * 登录获取的刷新token
+    */
+   refreshToken?: string;
+}

package/src/utils/data.ts

@@ -0,0 +1,64 @@
+/**
+ * QOD数据处理方法
+ */
+
+import { ReqParams } from "@skyfox2000/fapi";
+
+const mergeDeep = (
+   target?: Record<string, any>,
+   source?: Record<string, any>
+) => {
+   if (!source || !target) return;
+   for (const key in source) {
+      if (
+         key in target &&
+         typeof target[key] === "object" &&
+         typeof source[key] === "object" &&
+         !Array.isArray(source[key])
+      ) {
+         mergeDeep(target[key], source[key]);
+      } else {
+         target[key] = deepClone(source[key]);
+      }
+   }
+};
+
+// 深拷贝函数，用于创建对象的深拷贝
+const deepClone = (obj: any) => {
+   if (obj === null || typeof obj !== "object") {
+      return obj;
+   }
+   let cloneObj: any = Array.isArray(obj) ? [] : {};
+   for (let key in obj) {
+      if (obj.hasOwnProperty(key)) {
+         cloneObj[key] = deepClone(obj[key]);
+      }
+   }
+   return cloneObj;
+};
+
+/**
+ * 深度合并QOD参数
+ */
+export const combineParams = (...args: ReqParams[]): ReqParams => {
+   const mergedParams: ReqParams = {};
+
+   // 合并选项对象
+   for (const params of args) {
+      if (params?.Option && !mergedParams.Option) mergedParams.Option = {};
+      mergeDeep(mergedParams.Option, params?.Option);
+   }
+
+   // 合并查询对象
+   for (const params of args) {
+      if (params?.Query && !mergedParams.Query) mergedParams.Query = {};
+      mergeDeep(mergedParams.Query, params?.Query);
+   }
+
+   // 合并数据对象
+   for (const params of args) {
+      mergedParams.Data = params?.Data ? deepClone(params.Data) : {};
+   }
+
+   return mergedParams;
+};

package/src/utils/micro-app.ts

@@ -0,0 +1,106 @@
+import { HostInfo } from "@/stores/hostInfo";
+import { SettingInfo } from "@/stores/settingInfo";
+import { LoginInfo, UserInfo } from "@/stores/userInfo";
+import { ApiResponse } from "@skyfox2000/fapi";
+import { ref } from "vue";
+/**
+ * 是否微服务运行环境
+ * @returns
+ */
+export const isMicroApp = (): boolean => {
+   // @ts-ignore
+   if (window.__MICRO_APP_ENVIRONMENT__) {
+      return true;
+   }
+   return false;
+};
+
+/**
+ * 是否微服务基座应用
+ * @returns
+ */
+export const isBaseMicroApp = (): boolean => {
+   // @ts-ignore
+   if (window.__MICRO_APP_BASE_APPLICATION__) {
+      return true;
+   }
+   return false;
+};
+
+/**
+ * 主应用初始化数据格式
+ */
+export interface MainAppData {
+   /**
+    * 主应用开放接口
+    */
+   MainApis: MainOpenApis;
+   /**
+    * 主应用开放事件
+    */
+   MainEvents: MainOpenEvents;
+   /**
+    * 加载的页面地址
+    */
+   pageUrl: string;
+}
+
+/**
+ * 主应用开放接口
+ */
+export interface MainOpenApis {
+   /**
+    * 获取HostInfo
+    */
+   getHostInfo: () => HostInfo;
+   /**
+    * 用户注册接口
+    */
+   userRegister?: () => void;
+   /**
+    * 用户登录接口
+    */
+   userLogin?: (loginInfo: LoginInfo) => Promise<ApiResponse<LoginInfo> | void>;
+   /**
+    * 获取授权码
+    * @returns 授权码
+    */
+   getToken: () => string;
+   /**
+    * 获取当前用户信息
+    */
+   getUserInfo: () => UserInfo;
+   /**
+    * 获取前端设置信息
+    */
+   getSettingInfo?: () => SettingInfo;
+   /**
+    * 子应用推送路由变更
+    */
+   mainAppPush?: (subPath: string) => void;
+}
+/**
+ * 主应用开放事件注册
+ */
+export interface MainOpenEvents {
+   /**
+    * 前端设置信息变更
+    */
+   onSettingChanged?: () => void;
+}
+
+export const mainAppApis = ref<MainOpenApis | undefined>();
+export const mainAppEvents = ref<MainOpenEvents | undefined>();
+export const mainPageUrl = ref<string | undefined>();
+
+/**
+ * 从页面加载处获取接口
+ */
+export const initMainAppData = () => {
+   const mainAppData: MainAppData = window.microApp.getData(
+      true
+   ) as unknown as MainAppData;
+   mainAppApis.value = mainAppData.MainApis;
+   mainAppEvents.value = mainAppData.MainEvents;
+   mainPageUrl.value = mainAppData.pageUrl;
+};

package/src/vite-env.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="vite/client" />
+//解决ts文件引入vue文件出现红色警告问题
+declare module "*.vue" {
+   import { defineComponent } from "vue";
+   const Component: ReturnType<typeof defineComponent>;
+   export default Component;
+}
+
+import { EventCenterForMicroApp } from "@micro-zoe/micro-app";
+declare global {
+   interface Window {
+      microApp: EventCenterForMicroApp;
+   }
+}

package/tsconfig.json

@@ -0,0 +1,41 @@
+{
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
+    "declaration": true,
+    "emitDeclarationOnly": false,
+    "esModuleInterop": true,
+    "target": "ESNext",
+    "useDefineForClassFields": true,
+    "module": "ESNext",
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "skipLibCheck": true,
+    "removeComments": false,
+    "forceConsistentCasingInFileNames": true,
+
+    "composite": true,
+    "allowSyntheticDefaultImports": true,
+
+    /* Bundler mode */
+    "moduleResolution": "Bundler",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": false,
+    "jsx": "preserve",
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "baseUrl": "./", // 解析非相对模块的基地址，默认是当前目录
+    "paths": {
+      //路径映射，相对于baseUrl
+      "@/*": ["src/*"],
+    },
+    "typeRoots" : ["./node_modules/@types"],
+    "rootDir": "src",
+    "outDir": "lib",
+  },
+  "include": ["src/**/**.ts", "src/**/**.d.ts", "src/**/**.vue"],
+  "exclude": ["node_modules"]
+}

package/vite.config.ts

@@ -0,0 +1,71 @@
+import { ConfigEnv, defineConfig, loadEnv } from "vite";
+import vue from "@vitejs/plugin-vue";
+import path from "path";
+import dts from "vite-plugin-dts";
+
+// https://vitejs.dev/config/
+// @ts-ignore
+export default defineConfig(({ mode }: ConfigEnv) => {
+   const root = process.cwd();
+   const env = loadEnv(mode, root);
+   console.log(env);
+
+   return {
+      plugins: [
+         vue({
+            template: {
+               compilerOptions: {
+                  isCustomElement: (tag) => /^micro-app/.test(tag)
+               }
+            }
+         }),
+         dts({
+            outDir: "lib",
+            insertTypesEntry: true,
+            rollupTypes: true,
+            copyDtsFiles: true
+         })
+      ],
+      resolve: {
+         alias: {
+            "@": path.resolve("./src")
+         },
+         extensions: [".js", ".ts", ".vue", "json", ".png"]
+      },
+      build: {
+         outDir: "lib",
+         assetsDir: "assets",
+         lib: {
+            entry: "src/index.ts", // 指定入口文件
+            fileName: (format) => `microbase.${format}.js` // 输出文件名模板
+         },
+         rollupOptions: {
+            // 外部化处理那些你并不打算打包进库的依赖
+            external: [
+               "vue",
+               "@micro-zoe/micro-app",
+               "@skyfox2000/fapi",
+               "vue-router"
+            ],
+            // 如果你使用 TypeScript，则需要提供类型声明文件的输出路径
+            output: [
+               {
+                  globals: {}, // 这里指定 crypto-js 的全局变量名为 CryptoJS
+                  extend: false,
+                  // 提供多个模块格式
+                  format: "es",
+                  chunkFileNames: "assets/modules/[name]-[hash].js",
+                  assetFileNames: (assetInfo) => {
+                     if (assetInfo.name!.endsWith(".css")) {
+                        return "assets/css/[name].css";
+                     }
+                     return `assets/[ext]/[name]-[hash].[ext]`;
+                  }
+               }
+            ]
+         },
+         minify: true, // 开启压缩
+         sourcemap: false
+      }
+   };
+});