@pubinfo-nightly/core 2025.11.14

package/src/features/stores/utils/routerHelper.ts

@@ -0,0 +1,240 @@
+import type { RouterMetaRawBaseOptions } from '#/vue-router';
+import type { RequireExactlyOne } from 'type-fest';
+import { cloneDeep, isUndefined, omitBy } from 'lodash-es';
+import { setupDefaultLayout, setupPage } from '@/core';
+import { RESOURCE_TYPE } from '@/features/enum';
+
+export interface BackEndRoute {
+  name?: string
+  path?: string
+  component?: any
+  children: BackEndRoute[]
+  meta: RequireExactlyOne<Partial<RouterMetaRawBaseOptions>, 'title'> & Record<string, any>
+};
+
+/**
+ * 格式化后端返回的路由数据
+ * @param routes 路由数据
+ * @param parent 父级
+ * @returns 格式化后的路由数据
+ */
+export function formatBackRoutes(
+  routes: API.PubResourceTreeBo[] = [],
+  parent: API.PubResourceTreeBo = {},
+): BackEndRoute[] {
+  const backEndRoutes = filterRoutes(routes, [RESOURCE_TYPE.BUTTON]);
+
+  const formatRoutes = backEndRoutes.map((route: API.PubResourceTreeBo) => {
+    const children = route?.children && route.children.length > 0
+      ? formatBackRoutes(route.children, route)
+      : [];
+
+    const meta = omitBy<BackEndRoute['meta']>({
+      id: route?.id,
+      title: route?.name ?? '',
+      auth: route?.code,
+      icon: route?.icon,
+      ...route?.meta,
+
+      // 应用和动态应用不需要在侧边栏和标签栏显示，因为它们通过TopMode渲染
+      ...(route.type === RESOURCE_TYPE.APP || route.type === RESOURCE_TYPE.DYNAMIC_APP
+        ? {
+            sidebar: true, // 应用级别，默认显示
+            tabbar: true, // 应用级别，默认显示
+            // 确保开发模式文本有默认值
+            devText: route?.meta?.devText || '该功能暂未上线，敬请期待！',
+          }
+        : {}),
+
+      // 目录不在标签栏显示，但可在侧边栏显示
+      ...(route.type === RESOURCE_TYPE.INDEX
+        ? {
+            tabbar: true, // 目录本身不会在标签栏中显示
+          }
+        : {}),
+    }, isUndefined) as BackEndRoute['meta'];
+
+    const finalRoute = cloneDeep(omitBy<BackEndRoute>({
+      name: route?.meta?.routeName ?? undefined,
+      path: route?.meta?.url ?? undefined,
+      component: route?.meta?.component ?? undefined,
+      children,
+      meta,
+    }, isUndefined)) as BackEndRoute;
+
+    switch (route.type) {
+      case RESOURCE_TYPE.DYNAMIC_APP:
+        return finalRoute;
+
+      case RESOURCE_TYPE.INDEX:
+        return transformIndex(finalRoute, parent);
+
+      case RESOURCE_TYPE.MENU:
+      case RESOURCE_TYPE.IFRAME:
+      case RESOURCE_TYPE.LINK:
+        return transformMenuAndIframe(finalRoute, parent);
+
+      case RESOURCE_TYPE.NON_MENU:
+        return transformNonMenu(finalRoute, parent);
+
+      default:
+        return finalRoute;
+    }
+  });
+
+  return formatRoutes;
+}
+
+/** 过滤指定类型的路由 */
+function filterRoutes(routes: API.PubResourceTreeBo[] = [], excludes: string[]) {
+  return routes.filter((route) => {
+    if (!route.type) {
+      return false;
+    }
+    return !excludes.includes(route.type);
+  });
+}
+
+/** 过滤找不到SFC组件的路由 */
+export function filterEmptyComponentRoutes(routes: BackEndRoute[], minDepth = 3): BackEndRoute[] {
+  function recurse(route: BackEndRoute): BackEndRoute | null {
+    const children = route.children?.map(recurse).filter(Boolean) as BackEndRoute[] | undefined;
+
+    if (children && children.length > 0) {
+      return { ...route, children };
+    }
+
+    // 叶子且有 component
+    if (children?.length === 0 && route.component) {
+      const { children: _, ...rest } = route;
+      return { ...rest, children: [] };
+    }
+
+    return null;
+  }
+
+  function maxDepth(route: BackEndRoute): number {
+    if (!route.children || route.children.length === 0) {
+      return 1;
+    }
+    return 1 + Math.max(...route.children.map(maxDepth));
+  }
+
+  return routes
+    .map(recurse)
+    .filter((r): r is BackEndRoute => !!r)
+    .filter(r => maxDepth(r) >= minDepth);
+}
+
+/** 转换目录 */
+function transformIndex(route: BackEndRoute, parent: API.PubResourceTreeBo = {}): BackEndRoute {
+  switch (parent.type) {
+    // 父级是应用
+    case RESOURCE_TYPE.DYNAMIC_APP:
+      return {
+        ...route,
+        path: startsWithSlash(route.path),
+        component: setupDefaultLayout(),
+      };
+
+    // 父级是目录
+    case RESOURCE_TYPE.INDEX:
+      return {
+        ...route,
+        path: route.path,
+        component: undefined,
+      };
+
+    default:
+      return route;
+  }
+}
+
+/** 转换菜单和内嵌 */
+function transformMenuAndIframe(route: BackEndRoute, parent: API.PubResourceTreeBo = {}): BackEndRoute {
+  if (!route?.component && !route?.meta?.iframe && !route?.meta?.link) {
+    console.warn(`[PUBINFO] 资源"${route.meta.title}"的component字段不存在, 将会导致未知错误!`);
+  }
+
+  let menuRoute = cloneDeep(route);
+
+  // FIX-ME 在这里如果将 meta 修改为 route.meta 会产生多层级的问题。
+  const menuRouteChildren: BackEndRoute[] = [
+    {
+      path: '',
+      name: route.name,
+      component: replaceComponent(route.component, route.meta?.scope),
+      meta: {
+        ...route.meta,
+        title: route.meta.title,
+        sidebar: false,
+        breadcrumb: false,
+      },
+      children: [],
+    },
+    ...route.children,
+  ];
+
+  switch (parent.type) {
+    // 父级是应用
+    case RESOURCE_TYPE.DYNAMIC_APP:
+      menuRoute = {
+        ...route,
+        path: startsWithSlash(route.path),
+        name: undefined,
+        component: setupDefaultLayout(),
+        children: menuRouteChildren,
+      };
+      break;
+
+    // 父级是目录
+    case RESOURCE_TYPE.INDEX: {
+      menuRoute = {
+        ...route,
+        path: route.path,
+        name: undefined,
+        component: undefined,
+        children: menuRouteChildren,
+      };
+      break;
+    }
+  }
+
+  return menuRoute;
+}
+
+/** 转换非菜单页 */
+function transformNonMenu(route: BackEndRoute, parent: API.PubResourceTreeBo = {}): BackEndRoute {
+  switch (parent.type) {
+    // 父级是目录/菜单
+    case RESOURCE_TYPE.INDEX:
+    case RESOURCE_TYPE.MENU:
+    case RESOURCE_TYPE.NON_MENU:
+      return {
+        ...route,
+        path: route.path,
+        component: replaceComponent(route.component, route.meta?.scope),
+        meta: {
+          ...route.meta,
+          sidebar: false,
+        },
+      };
+
+    default:
+      return route;
+  }
+}
+
+/** 开头添加 / */
+function startsWithSlash(str?: string) {
+  if (!str) {
+    return '/';
+  }
+
+  return str.startsWith('/') ? str : `/${str}`;
+}
+
+/** 替换 component 为实际组件 */
+function replaceComponent(component: any, id?: string) {
+  return setupPage(component, id);
+}

package/src/index.ts

@@ -0,0 +1,127 @@
+import type { Options, RequestInstance } from './core';
+import {
+  Authentication,
+  Authorization,
+  Devtools,
+  LayoutComponent,
+  NProgress,
+  PiniaPlugin,
+  PreAccess,
+  Settings,
+  SystemInfo,
+} from './built-in';
+import { createApp } from './core';
+import { createPubinfoContext } from './features/context/index.ts';
+import '../types/index.d.ts';
+
+export interface PubinfoOptions extends Options {
+  /**
+   * 请求实例
+   */
+  request: {
+    auth: RequestInstance
+    basic: RequestInstance
+  }
+
+  /**
+   * 纯净模式
+   * @default false
+   */
+  pure?: boolean
+}
+
+export function createPubinfo(options: PubinfoOptions) {
+  const {
+    pure = false,
+    router,
+    request,
+  } = options;
+
+  if (pure) {
+    return createApp(options);
+  }
+
+  return createApp({
+    ...options,
+    router: {
+      ...router,
+      routes: [
+        ...router.routes,
+        {
+          path: '/:all(.*)*',
+          name: 'NotFound',
+          component: () => import('@/features/pages/not-found/index.vue'),
+          meta: { title: '找不到页面' },
+        },
+      ],
+    },
+    modules: [
+      {
+        name: 'built-in:context',
+        enforce: 'pre',
+        setup(ctx) {
+          createPubinfoContext({
+            router: ctx.router,
+            requestAuth: request.auth,
+            requestBasic: request.basic,
+          });
+        },
+      },
+      PiniaPlugin(),
+      PreAccess(),
+      Authentication(),
+      Authorization(),
+      LayoutComponent(),
+      Settings(),
+      NProgress(),
+      SystemInfo(),
+      ...(options.modules ?? []),
+      Devtools(),
+    ],
+  });
+}
+
+export { RESPONSE_CODE } from './built-in/authentication';
+export {
+  Copyright,
+  Layout,
+  LayoutContent,
+  LayoutHeader,
+  LayoutProvider,
+  LayoutSidebar,
+  LayoutTopbar,
+  Logo,
+  NotAllowed,
+  Tool,
+  Tools,
+} from './built-in/layout-component';
+export type { DropdownMenu, DropdownMenuRender } from './built-in/layout-component';
+export { updateWatermark } from './built-in/layout-component/composables/useWatermark';
+
+export {
+  createRequest,
+  defineIconModule,
+  defineRouteModule,
+  getAllIconModules,
+  getAllRouteModules,
+  readProjectModules,
+} from './core';
+export * from './core/interface';
+export {
+  clearPersistedState,
+  createContext,
+  getPersistedState,
+  getPubinfoNamespace,
+  setPersistedState,
+} from './core/utils';
+
+export * from './features';
+
+export {
+  cleanup,
+  cleanupWithoutUser,
+  createRawContext,
+  publicKeyEncryption,
+  storage,
+  wrapProxy,
+} from './utils';

package/src/utils/cleanup.ts

@@ -0,0 +1,19 @@
+import { useIframeStore, useMenuStore, useRouteStore, useTabbarStore, useUserStore } from '@/features/stores';
+
+/**
+ * 清理所有 store 中的状态
+ */
+export function cleanup() {
+  useUserStore().clean();
+  cleanupWithoutUser();
+}
+
+/**
+ * 清理 userStore 以外的所有 store 状态
+ */
+export function cleanupWithoutUser() {
+  useTabbarStore().clean();
+  useIframeStore().clean();
+  useRouteStore().removeRoutes();
+  useMenuStore().setActived(0);
+}

package/src/utils/index.ts

@@ -0,0 +1,6 @@
+export * from './cleanup';
+export * from './path';
+export * from './proxy';
+export * from './publicKey';
+export * from './storage';
+export { createContext as createRawContext } from 'unctx';

package/src/utils/path.ts

@@ -0,0 +1,5 @@
+import path from 'path-browserify';
+
+export function resolveRoutePath(basePath?: string, routePath?: string) {
+  return basePath ? path.resolve(basePath, routePath ?? '') : routePath ?? '';
+}

package/src/utils/proxy.ts

@@ -0,0 +1,35 @@
+import { getPersistedState } from '../core/utils';
+
+export function wrapProxy<T extends Record<K, any>, K extends keyof T>(
+  fn: () => T,
+  key: K,
+): T[K] {
+  return new Proxy({} as T[K], {
+    get(_, prop: string | symbol) {
+      let context: T | undefined;
+      try {
+        context = fn();
+      }
+      catch (e) {
+        // 1. 从全局缓存读取
+        const cached = getPersistedState<T>('state');
+        if (cached && cached[key]) {
+          const inst = cached[key];
+          const val = (inst as any)[prop];
+          return typeof val === 'function' ? val.bind(inst) : val;
+        }
+        throw e;
+      }
+      const instance = context[key];
+
+      if (!instance) {
+        throw new Error(
+          `Instance "${String(key)}" has not been set. Please call createContext() before using "${String(prop)}".`,
+        );
+      }
+
+      const value = instance[prop as keyof typeof instance];
+      return typeof value === 'function' ? value.bind(instance) : value;
+    },
+  });
+}

package/src/utils/publicKey.ts

@@ -0,0 +1,23 @@
+import JSEncrypt from 'jsencrypt';
+import { template } from 'lodash-es';
+import { getAuthLoginKey } from '@/features/api/modules/auth';
+
+function compilePublicKey(key: string) {
+  const compiled = template('-----BEGIN PUBLIC KEY-----\n<%= publickKey %>\n-----END PUBLIC KEY-----');
+  return compiled({ publickKey: key });
+}
+
+async function getPublicKey() {
+  const res = await getAuthLoginKey();
+  return compilePublicKey(res.data ?? '');
+}
+
+/**
+ * 使用 `publicKey` 进行加密
+ */
+export async function publicKeyEncryption(content: string) {
+  const publicKey = await getPublicKey();
+  const encryptor = new JSEncrypt();
+  encryptor.setPublicKey(publicKey);
+  return encryptor.encrypt(content) as string;
+}

package/src/utils/storage.ts

@@ -0,0 +1,55 @@
+import { getSettings } from '@/features/settings';
+
+function getStoragePrefix() {
+  const settings = getSettings();
+  return settings?.app?.storagePrefix;
+}
+
+export const storage = {
+  local: {
+    has: (key: string) => {
+      return Object.prototype.hasOwnProperty.call(localStorage, `${getStoragePrefix()}${key}`);
+    },
+    get: (key: string) => {
+      return localStorage.getItem(`${getStoragePrefix()}${key}`);
+    },
+    set: (key: string, value: string) => {
+      localStorage.setItem(`${getStoragePrefix()}${key}`, value);
+    },
+    remove: (key: string) => {
+      localStorage.removeItem(`${getStoragePrefix()}${key}`);
+    },
+    clear: () => {
+      localStorage.clear();
+    },
+    getItem: (key: string) => {
+      return localStorage.getItem(`${getStoragePrefix()}${key}`);
+    },
+    setItem: (key: string, value: string) => {
+      localStorage.setItem(`${getStoragePrefix()}${key}`, value);
+    },
+  },
+  session: {
+    has: (key: string) => {
+      return Object.prototype.hasOwnProperty.call(sessionStorage, `${getStoragePrefix()}${key}`);
+    },
+    get: (key: string) => {
+      return sessionStorage.getItem(`${getStoragePrefix()}${key}`);
+    },
+    set: (key: string, value: string) => {
+      sessionStorage.setItem(`${getStoragePrefix()}${key}`, value);
+    },
+    remove: (key: string) => {
+      sessionStorage.removeItem(`${getStoragePrefix()}${key}`);
+    },
+    clear: () => {
+      sessionStorage.clear();
+    },
+    getItem: (key: string) => {
+      return sessionStorage.getItem(`${getStoragePrefix()}${key}`);
+    },
+    setItem: (key: string, value: string) => {
+      sessionStorage.setItem(`${getStoragePrefix()}${key}`, value);
+    },
+  },
+};

package/types/auto-imports.d.ts

@@ -0,0 +1,78 @@
+/* eslint-disable */
+/* prettier-ignore */
+// @ts-nocheck
+// noinspection JSUnusedGlobalSymbols
+// Generated by unplugin-auto-import
+// biome-ignore lint: disable
+export {}
+declare global {
+  const EffectScope: typeof import('vue')['EffectScope']
+  const computed: typeof import('vue')['computed']
+  const createApp: typeof import('vue')['createApp']
+  const customRef: typeof import('vue')['customRef']
+  const defineAsyncComponent: typeof import('vue')['defineAsyncComponent']
+  const defineComponent: typeof import('vue')['defineComponent']
+  const effectScope: typeof import('vue')['effectScope']
+  const getCurrentInstance: typeof import('vue')['getCurrentInstance']
+  const getCurrentScope: typeof import('vue')['getCurrentScope']
+  const getCurrentWatcher: typeof import('vue')['getCurrentWatcher']
+  const h: typeof import('vue')['h']
+  const inject: typeof import('vue')['inject']
+  const isProxy: typeof import('vue')['isProxy']
+  const isReactive: typeof import('vue')['isReactive']
+  const isReadonly: typeof import('vue')['isReadonly']
+  const isRef: typeof import('vue')['isRef']
+  const isShallow: typeof import('vue')['isShallow']
+  const markRaw: typeof import('vue')['markRaw']
+  const nextTick: typeof import('vue')['nextTick']
+  const onActivated: typeof import('vue')['onActivated']
+  const onBeforeMount: typeof import('vue')['onBeforeMount']
+  const onBeforeRouteLeave: typeof import('vue-router')['onBeforeRouteLeave']
+  const onBeforeRouteUpdate: typeof import('vue-router')['onBeforeRouteUpdate']
+  const onBeforeUnmount: typeof import('vue')['onBeforeUnmount']
+  const onBeforeUpdate: typeof import('vue')['onBeforeUpdate']
+  const onDeactivated: typeof import('vue')['onDeactivated']
+  const onErrorCaptured: typeof import('vue')['onErrorCaptured']
+  const onMounted: typeof import('vue')['onMounted']
+  const onRenderTracked: typeof import('vue')['onRenderTracked']
+  const onRenderTriggered: typeof import('vue')['onRenderTriggered']
+  const onScopeDispose: typeof import('vue')['onScopeDispose']
+  const onServerPrefetch: typeof import('vue')['onServerPrefetch']
+  const onUnmounted: typeof import('vue')['onUnmounted']
+  const onUpdated: typeof import('vue')['onUpdated']
+  const onWatcherCleanup: typeof import('vue')['onWatcherCleanup']
+  const provide: typeof import('vue')['provide']
+  const reactive: typeof import('vue')['reactive']
+  const readonly: typeof import('vue')['readonly']
+  const ref: typeof import('vue')['ref']
+  const resolveComponent: typeof import('vue')['resolveComponent']
+  const shallowReactive: typeof import('vue')['shallowReactive']
+  const shallowReadonly: typeof import('vue')['shallowReadonly']
+  const shallowRef: typeof import('vue')['shallowRef']
+  const toRaw: typeof import('vue')['toRaw']
+  const toRef: typeof import('vue')['toRef']
+  const toRefs: typeof import('vue')['toRefs']
+  const toValue: typeof import('vue')['toValue']
+  const triggerRef: typeof import('vue')['triggerRef']
+  const unref: typeof import('vue')['unref']
+  const useAttrs: typeof import('vue')['useAttrs']
+  const useCssModule: typeof import('vue')['useCssModule']
+  const useCssVars: typeof import('vue')['useCssVars']
+  const useId: typeof import('vue')['useId']
+  const useLink: typeof import('vue-router')['useLink']
+  const useModel: typeof import('vue')['useModel']
+  const useRoute: typeof import('vue-router')['useRoute']
+  const useRouter: typeof import('vue-router')['useRouter']
+  const useSlots: typeof import('vue')['useSlots']
+  const useTemplateRef: typeof import('vue')['useTemplateRef']
+  const watch: typeof import('vue')['watch']
+  const watchEffect: typeof import('vue')['watchEffect']
+  const watchPostEffect: typeof import('vue')['watchPostEffect']
+  const watchSyncEffect: typeof import('vue')['watchSyncEffect']
+}
+// for type re-export
+declare global {
+  // @ts-ignore
+  export type { Component, Slot, Slots, ComponentPublicInstance, ComputedRef, DirectiveBinding, ExtractDefaultPropTypes, ExtractPropTypes, ExtractPublicPropTypes, InjectionKey, PropType, Ref, ShallowRef, MaybeRef, MaybeRefOrGetter, VNode, WritableComputedRef } from 'vue'
+  import('vue')
+}

package/types/components.d.ts

@@ -0,0 +1,48 @@
+/* eslint-disable */
+// @ts-nocheck
+// Generated by unplugin-vue-components
+// Read more: https://github.com/vuejs/core/pull/3399
+// biome-ignore lint: disable
+export {}
+
+/* prettier-ignore */
+declare module 'vue' {
+  export interface GlobalComponents {
+    AAlert: typeof import('ant-design-vue/es')['Alert']
+    AButton: typeof import('ant-design-vue/es')['Button']
+    ACard: typeof import('ant-design-vue/es')['Card']
+    ACheckbox: typeof import('ant-design-vue/es')['Checkbox']
+    ADivider: typeof import('ant-design-vue/es')['Divider']
+    AForm: typeof import('ant-design-vue/es')['Form']
+    AFormItem: typeof import('ant-design-vue/es')['FormItem']
+    AInput: typeof import('ant-design-vue/es')['Input']
+    AInputNumber: typeof import('ant-design-vue/es')['InputNumber']
+    AInputPassword: typeof import('ant-design-vue/es')['InputPassword']
+    AModal: typeof import('ant-design-vue/es')['Modal']
+    ARadioButton: typeof import('ant-design-vue/es')['RadioButton']
+    ARadioGroup: typeof import('ant-design-vue/es')['RadioGroup']
+    ASelect: typeof import('ant-design-vue/es')['Select']
+    ASelectOption: typeof import('ant-design-vue/es')['SelectOption']
+    ATag: typeof import('ant-design-vue/es')['Tag']
+    ATooltip: typeof import('ant-design-vue/es')['Tooltip']
+    ATreeSelect: typeof import('ant-design-vue/es')['TreeSelect']
+    DeleteOutlined: typeof import('@ant-design/icons-vue')['DeleteOutlined']
+    HBadge: typeof import('./../src/built-in/layout-component/components/ui/HBadge.vue')['default']
+    HButton: typeof import('./../src/built-in/layout-component/components/ui/HButton.vue')['default']
+    HCheckList: typeof import('./../src/built-in/layout-component/components/ui/HCheckList.vue')['default']
+    HDialog: typeof import('./../src/built-in/layout-component/components/ui/HDialog.vue')['default']
+    HDivider: typeof import('./../src/built-in/layout-component/components/ui/HDivider.vue')['default']
+    HDropdown: typeof import('./../src/built-in/layout-component/components/ui/HDropdown.vue')['default']
+    HDropdownMenu: typeof import('./../src/built-in/layout-component/components/ui/HDropdownMenu.vue')['default']
+    HDropdownTree: typeof import('./../src/built-in/layout-component/components/ui/HDropdownTree.vue')['default']
+    HInput: typeof import('./../src/built-in/layout-component/components/ui/HInput.vue')['default']
+    HKbd: typeof import('./../src/built-in/layout-component/components/ui/HKbd.vue')['default']
+    HSelect: typeof import('./../src/built-in/layout-component/components/ui/HSelect.vue')['default']
+    HSlideover: typeof import('./../src/built-in/layout-component/components/ui/HSlideover.vue')['default']
+    HTabList: typeof import('./../src/built-in/layout-component/components/ui/HTabList.vue')['default']
+    HToggle: typeof import('./../src/built-in/layout-component/components/ui/HToggle.vue')['default']
+    HTooltip: typeof import('./../src/built-in/layout-component/components/ui/HTooltip.vue')['default']
+    RouterLink: typeof import('vue-router')['RouterLink']
+    RouterView: typeof import('vue-router')['RouterView']
+  }
+}

package/types/favorites.d.ts

@@ -0,0 +1,8 @@
+export declare namespace Favorites {
+  interface recordRaw {
+    fullPath: string
+    title?: string | (() => string)
+    i18n?: string
+    icon?: string
+  }
+}

package/types/global.d.ts

@@ -0,0 +1,12 @@
+declare const __SYSTEM_INFO__: {
+  pkg: {
+    dependencies: Record<string, string>
+    devDependencies: Record<string, string>
+  }
+  git: {
+    commit: string
+    commitShort: string
+    branch: string
+  }
+  buildTime: string
+};

package/types/iframe.d.ts

@@ -0,0 +1,8 @@
+export declare namespace Iframe {
+  interface recordRaw {
+    path: string
+    src: string
+    isOpen: boolean
+    isLoading: boolean
+  }
+}

package/types/index.d.ts

@@ -0,0 +1,10 @@
+import './favorites.d.ts';
+import './iframe.d.ts';
+import './menu.d.ts';
+import './module.d.ts';
+import './pinia.d.ts';
+import './settings.d.ts';
+import './tabbar.d.ts';
+import './user.d.ts';
+import './vite-env.d.ts';
+import './vue-router.d.ts';