@pubinfo/core 2.0.0-beta.9 → 2.0.0-rc.1

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

@@ -0,0 +1,221 @@
+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>
+};
+
+export const MicroAppContainer = () => import('@/features/components/MicroAppContainer/index.vue');
+
+/**
+ * 格式化后端返回的路由数据
+ * @param routes 路由数据
+ * @param parent 父级
+ * @returns 格式化后的路由数据
+ */
+export function formatBackRoutes(
+  routes: API.PubResourceTreeBo[] = [],
+  parent: API.PubResourceTreeBo = {},
+): BackEndRoute[] {
+  const backEndRoutes = filterRoutes(routes, [RESOURCE_TYPE.BUTTON]);
+
+  return backEndRoutes.map((route: API.PubResourceTreeBo) => {
+    const children = route?.children && route.children.length > 0
+      ? formatBackRoutes(route.children, route)
+      : [];
+
+    const meta = omitBy<BackEndRoute['meta']>({
+      title: route?.name ?? '',
+      auth: route?.code,
+      icon: route?.icon,
+      ...route?.meta,
+
+      // CLOSE: 根据资源类型设置正确的显示属性
+      // 应用和动态应用不需要在侧边栏和标签栏显示，因为它们通过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'];
+
+    // TODO: 这里的逻辑可能需要根据实际情况调整
+    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:
+      case RESOURCE_TYPE.MICRO_APP:
+        return finalRoute;
+
+      case RESOURCE_TYPE.INDEX:
+        return transformIndex(finalRoute, parent);
+
+      case RESOURCE_TYPE.MENU:
+      case RESOURCE_TYPE.IFRAME:
+        return transformMenuAndIframe(finalRoute, parent);
+
+      case RESOURCE_TYPE.NON_MENU:
+        return transformNonMenu(finalRoute, parent);
+
+      case RESOURCE_TYPE.LINK:
+        return finalRoute;
+
+      default:
+        return finalRoute;
+    }
+  });
+}
+
+/** 过滤指定类型的路由 */
+function filterRoutes(routes: API.PubResourceTreeBo[] = [], excludes: string[]) {
+  return routes.filter((route) => {
+    if (!route.type) {
+      return false;
+    }
+    return !excludes.includes(route.type);
+  });
+}
+
+/** 转换目录 */
+function transformIndex(route: BackEndRoute, parent: API.PubResourceTreeBo = {}): BackEndRoute {
+  switch (parent.type) {
+    // 父级是应用
+    case RESOURCE_TYPE.DYNAMIC_APP:
+    case RESOURCE_TYPE.MICRO_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) {
+    console.warn(`[PUBINFO] 资源"${route.meta.title}"的component字段不存在, 将会导致未知错误!`);
+  }
+
+  let menuRoute = cloneDeep(route);
+
+  // FIX-ME 在这里如果将 meta 修改为 route.meta 会产生多层级的问题。
+  const menuRouteChildren: BackEndRoute[] = [
+    {
+      path: '',
+      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:
+    case RESOURCE_TYPE.MICRO_APP:
+      menuRoute = {
+        ...route,
+        path: startsWithSlash(route.path),
+        component: setupDefaultLayout(),
+        children: menuRouteChildren,
+      };
+      break;
+
+    // 父级是目录
+    case RESOURCE_TYPE.INDEX: {
+      menuRoute = {
+        ...route,
+        path: route.path,
+        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}`;
+}
+
+/** 开头去掉 / */
+function startsWithNoSlash(str?: string) {
+  if (!str) {
+    return '';
+  }
+
+  return str.startsWith('/') ? str.replace('/', '') : str;
+}
+
+/** 替换 component 为实际组件 */
+function replaceComponent(component: any, id?: string) {
+  return setupPage(component, id);
+}

package/src/index.ts

@@ -1,12 +1,117 @@
-import './assets/styles';
-
-export * from './components';
-export * from './composables';
-export * from './config';
-export * from './context';
-export * from './create';
-export * from './interface';
-export * from './layout';
-export * from './route';
-export * from './stores';
-export * from './utils';
+import type { Options, RequestInstance } from './core';
+import {
+  Authentication,
+  Authorization,
+  LayoutComponent,
+  Locales,
+  NProgress,
+  PiniaPlugin,
+  PreAccess,
+  Settings,
+} 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',
+        setup(ctx) {
+          createPubinfoContext({
+            router: ctx.router,
+            requestAuth: request.auth,
+            requestBasic: request.basic,
+          });
+        },
+      },
+      PiniaPlugin(),
+      PreAccess(),
+      Authentication(),
+      Authorization(),
+      LayoutComponent(),
+      Settings(),
+      Locales(),
+      NProgress(),
+      ...(options.modules ?? []),
+    ],
+  });
+}
+
+export {
+  BackTop,
+  Copyright,
+  Layout,
+  LayoutContent,
+  LayoutHeader,
+  LayoutProvider,
+  Logo,
+  Menu,
+  RESPONSE_CODE,
+  SettingBar,
+  Sidebar,
+  Tools,
+  Topbar,
+} from './built-in';
+export { eventBus } from './built-in/layout-component/utils';
+
+export {
+  createRequest,
+  defineIconModule,
+  defineRouteModule,
+  getAllIconModules,
+  getAllRouteModules,
+  readProjectModules,
+} from './core';
+
+export * from './core/interface';
+
+export * from './features';
+
+export {
+  cleanup,
+  cleanupWithoutUser,
+  createContext,
+  storage,
+  wrapProxy,
+} from './utils';

package/src/utils/cleanup.ts

@@ -1,4 +1,4 @@
-import { useMenuStore, useRouteStore, useTabbarStore, useUserStore } from '@/stores';
+import { useMenuStore, useRouteStore, useTabbarStore, useUserStore } from '@/features/stores';
 
 /**
  * 清理所有 store 中的状态

package/src/utils/index.ts

@@ -1,44 +1,5 @@
-import type { Primitive } from 'type-fest';
-import { isArray, isEmpty, isObject, reduce } from 'lodash-es';
-import path from 'path-browserify';
-
-type ConditionalExceptType<T extends Record<PropertyKey, any>, Type> = {
-  [P in keyof T]: Exclude<T[P], Type>
-};
-
-export function resolveRoutePath(basePath?: string, routePath?: string) {
-  return basePath ? path.resolve(basePath, routePath ?? '') : routePath ?? '';
-}
-
-export function normalizePrimitiveToFunction<T extends Record<PropertyKey, any>>(options: T): ConditionalExceptType<T, Primitive> {
-  for (const key in options) {
-    if (typeof options[key] !== 'function') {
-      const value = options[key]
-      ;(options[key] as () => typeof value) = () => value;
-    }
-  }
-  return options;
-}
-
-export function objectToPaths(obj: Record<string, any>, prefix = '') {
-  return reduce(obj, (result, value, key) => {
-    const fullPath = prefix.length ? `${prefix}.${key}` : key;
-    if (isObject(value) && !isArray(value) && !isEmpty(value)) {
-      // 如果是非空对象，递归调用
-      result = result.concat(objectToPaths(value, fullPath));
-    }
-    else {
-      // 否则，添加当前路径到结果数组
-      result.push(fullPath);
-    }
-    return result;
-  }, [] as string[]);
-}
-
 export * from './cleanup';
-export * from './crypto';
-export { default as eventBus } from './eventBus';
-export * from './injectionKeys';
-export { default as storage } from './storage';
-export * from './utils';
-export { default as watermark } from './watermark';
+export * from './path';
+export * from './proxy';
+export * from './storage';
+export { createContext } 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,36 @@
+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 g: any = globalThis as any;
+        if (g.__PUBINFO__?.state) {
+          const cached = g.__PUBINFO__.state as T;
+          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/storage.ts

@@ -1,11 +1,11 @@
-import { getSettings } from '@/config';
+import { getSettings } from '@/features/settings';
 
 function getStoragePrefix() {
   const settings = getSettings();
   return settings?.app?.storagePrefix;
 }
 
-const storage = {
+export const storage = {
   local: {
     has: (key: string) => {
       return Object.prototype.hasOwnProperty.call(localStorage, `${getStoragePrefix()}${key}`);
@@ -53,5 +53,3 @@ const storage = {
     },
   },
 };
-
-export default storage;

package/types/auto-imports.d.ts

@@ -15,12 +15,14 @@ declare global {
   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']
@@ -54,25 +56,16 @@ declare global {
   const triggerRef: typeof import('vue')['triggerRef']
   const unref: typeof import('vue')['unref']
   const useAttrs: typeof import('vue')['useAttrs']
-  const useAuth: typeof import('../src/composables/auth')['useAuth']
-  const useBox: typeof import('../src/composables/log')['useBox']
   const useCssModule: typeof import('vue')['useCssModule']
   const useCssVars: typeof import('vue')['useCssVars']
-  const useError: typeof import('../src/composables/log')['useError']
   const useId: typeof import('vue')['useId']
-  const useInfo: typeof import('../src/composables/log')['useInfo']
   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 useStart: typeof import('../src/composables/log')['useStart']
-  const useSuccess: typeof import('../src/composables/log')['useSuccess']
   const useTemplateRef: typeof import('vue')['useTemplateRef']
-  const useTheme: typeof import('../src/composables/theme')['useTheme']
-  const useWarn: typeof import('../src/composables/log')['useWarn']
   const watch: typeof import('vue')['watch']
-  const watchDiffObject: typeof import('../src/composables/watchDiff')['watchDiffObject']
   const watchEffect: typeof import('vue')['watchEffect']
   const watchPostEffect: typeof import('vue')['watchPostEffect']
   const watchSyncEffect: typeof import('vue')['watchSyncEffect']
@@ -80,6 +73,6 @@ declare global {
 // for type re-export
 declare global {
   // @ts-ignore
-  export type { Component, ComponentPublicInstance, ComputedRef, DirectiveBinding, ExtractDefaultPropTypes, ExtractPropTypes, ExtractPublicPropTypes, InjectionKey, PropType, Ref, MaybeRef, MaybeRefOrGetter, VNode, WritableComputedRef } from 'vue'
+  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

@@ -2,6 +2,7 @@
 // @ts-nocheck
 // Generated by unplugin-vue-components
 // Read more: https://github.com/vuejs/core/pull/3399
+// biome-ignore lint: disable
 export {}
 
 /* prettier-ignore */
@@ -15,21 +16,21 @@ declare module 'vue' {
     AFormItem: typeof import('ant-design-vue/es')['FormItem']
     AInputPassword: typeof import('ant-design-vue/es')['InputPassword']
     ATag: typeof import('ant-design-vue/es')['Tag']
-    HBadge: typeof import('./../src/layout/ui-kit/HBadge.vue')['default']
-    HButton: typeof import('./../src/layout/ui-kit/HButton.vue')['default']
-    HCheckList: typeof import('./../src/layout/ui-kit/HCheckList.vue')['default']
-    HDialog: typeof import('./../src/layout/ui-kit/HDialog.vue')['default']
-    HDivider: typeof import('./../src/layout/ui-kit/HDivider.vue')['default']
-    HDropdown: typeof import('./../src/layout/ui-kit/HDropdown.vue')['default']
-    HDropdownMenu: typeof import('./../src/layout/ui-kit/HDropdownMenu.vue')['default']
-    HDropdownTree: typeof import('./../src/layout/ui-kit/HDropdownTree.vue')['default']
-    HInput: typeof import('./../src/layout/ui-kit/HInput.vue')['default']
-    HKbd: typeof import('./../src/layout/ui-kit/HKbd.vue')['default']
-    HSelect: typeof import('./../src/layout/ui-kit/HSelect.vue')['default']
-    HSlideover: typeof import('./../src/layout/ui-kit/HSlideover.vue')['default']
-    HTabList: typeof import('./../src/layout/ui-kit/HTabList.vue')['default']
-    HToggle: typeof import('./../src/layout/ui-kit/HToggle.vue')['default']
-    HTooltip: typeof import('./../src/layout/ui-kit/HTooltip.vue')['default']
+    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/menu.d.ts

@@ -24,7 +24,9 @@ export declare namespace Menu {
       icon?: string
       activeIcon?: string
       auth?: string | string[]
+      sidebar?: boolean
       isDev?: boolean
+      devText?: string
     }
     children: recordRaw[]
   }

package/types/module.d.ts

@@ -1,18 +1,5 @@
-declare module 'pubinfo:project/api/request' {
-  import type { AlovaAxiosRequestConfig } from '@alova/adapter-axios';
-  import type { Alova, AlovaGenerics } from 'alova';
-  import type { AxiosResponse, AxiosResponseHeaders } from 'axios';
-
-  type RequestInstance = Alova<AlovaGenerics<any, any, AlovaAxiosRequestConfig, AxiosResponse<any, any>, AxiosResponseHeaders, any, any, any>>;
-  export const basic: RequestInstance;
-  export const auth: RequestInstance;
-}
-
-declare module 'pubinfo:project/layouts/index.vue' {
-  import type { DefineComponent } from 'vue';
-
-  const component: DefineComponent<object, object, any>;
-  export default component;
+declare module 'virtual:pubinfo-resolver' {
+  export default any;
 }
 
 declare module '*.vue' {

package/types/settings.d.ts

@@ -81,14 +81,6 @@ declare namespace Settings {
      */
     enableErrorLog?: boolean
 
-    /**
-     * 路由数据来源
-     *
-     * @默认值 `'frontend'` 前端
-     * @可选值 `'backend'` 后端
-     */
-    routeBaseOn?: | 'frontend' | 'backend'
-
     /**
      * 是否开启用户偏好设置
      *

package/types/tabbar.d.ts

@@ -18,6 +18,7 @@ export declare namespace Tabbar {
       title: string
     }[]
     isPin: boolean
+    isTabbar: boolean
     isPermanent: boolean
   }
 }

package/types/vue-router.d.ts

@@ -25,19 +25,23 @@ export interface RouterMetaRawBaseOptions {
   breadcrumbNeste: Route.breadcrumb[]
   isDev: boolean
   enabled: boolean
+  provider?: any
+  pin?: boolean
+  routeName?: string
 }
 
 type RouterMetaRaw = RequireExactlyOne<Partial<RouterMetaRawBaseOptions>, 'title'>;
 
 export declare namespace Route {
 
-  type mainMeta =
-    | 'title'
-    | 'i18n'
-    | 'icon'
-    | 'activeIcon'
-    | 'auth'
-    | 'enabled';
+  type mainMeta
+    = | 'title'
+      | 'i18n'
+      | 'icon'
+      | 'activeIcon'
+      | 'auth'
+      | 'enabled'
+      | 'provider';
 
   type recordMainRawBasicMeta = Partial<Pick<RouterMetaRawBaseOptions, mainMeta>>;