更新最新代码

packages/@core/base/typings/build.config.ts

@@ -0,0 +1,7 @@
+import { defineBuildConfig } from 'unbuild';
+
+export default defineBuildConfig({
+  clean: true,
+  declaration: true,
+  entries: ['src/index'],
+});

packages/@core/base/typings/src/basic.d.ts

@@ -0,0 +1,35 @@
+interface BasicOption {
+  label: string;
+  value: string;
+}
+
+type SelectOption = BasicOption;
+
+type TabOption = BasicOption;
+
+interface BasicUserInfo {
+  /**
+   * 头像
+   */
+  avatar: string;
+  /**
+   * 用户昵称
+   */
+  nickname: string;
+  /**
+   * 用户角色
+   */
+  roles?: string[];
+  /**
+   * 用户id
+   */
+  userId: string;
+  /**
+   * 用户名
+   */
+  username: string;
+}
+
+type ClassType = Array<object | string> | object | string;
+
+export type { BasicOption, BasicUserInfo, ClassType, SelectOption, TabOption };

packages/@core/base/typings/src/helper.d.ts

@@ -0,0 +1,132 @@
+import type { ComputedRef, MaybeRef } from 'vue';
+
+/**
+ * 深层递归所有属性为可选
+ */
+type DeepPartial<T> = T extends object
+  ? {
+      [P in keyof T]?: DeepPartial<T[P]>;
+    }
+  : T;
+
+/**
+ * 深层递归所有属性为只读
+ */
+type DeepReadonly<T> = {
+  readonly [P in keyof T]: T[P] extends object ? DeepReadonly<T[P]> : T[P];
+};
+
+/**
+ * 任意类型的异步函数
+ */
+
+type AnyPromiseFunction<T extends any[] = any[], R = void> = (
+  ...arg: T
+) => PromiseLike<R>;
+
+/**
+ * 任意类型的普通函数
+ */
+type AnyNormalFunction<T extends any[] = any[], R = void> = (...arg: T) => R;
+
+/**
+ * 任意类型的函数
+ */
+type AnyFunction<T extends any[] = any[], R = void> =
+  | AnyNormalFunction<T, R>
+  | AnyPromiseFunction<T, R>;
+
+/**
+ *  T | null 包装
+ */
+type Nullable<T> = null | T;
+
+/**
+ * T | Not null 包装
+ */
+type NonNullable<T> = T extends null | undefined ? never : T;
+
+/**
+ * 字符串类型对象
+ */
+type Recordable<T> = Record<string, T>;
+
+/**
+ * 字符串类型对象（只读）
+ */
+interface ReadonlyRecordable<T = any> {
+  readonly [key: string]: T;
+}
+
+/**
+ * setTimeout 返回值类型
+ */
+type TimeoutHandle = ReturnType<typeof setTimeout>;
+
+/**
+ * setInterval 返回值类型
+ */
+type IntervalHandle = ReturnType<typeof setInterval>;
+
+/**
+ * 也许它是一个计算的 ref，或者一个 getter 函数
+ *
+ */
+type MaybeReadonlyRef<T> = (() => T) | ComputedRef<T>;
+
+/**
+ * 也许它是一个 ref，或者一个普通值，或者一个 getter 函数
+ *
+ */
+type MaybeComputedRef<T> = MaybeReadonlyRef<T> | MaybeRef<T>;
+
+type Merge<O extends object, T extends object> = {
+  [K in keyof O | keyof T]: K extends keyof T
+    ? T[K]
+    : K extends keyof O
+      ? O[K]
+      : never;
+};
+
+/**
+ * T = [
+ *  { name: string; age: number; },
+ *  { sex: 'male' | 'female'; age: string }
+ * ]
+ * =>
+ * MergeAll<T> = {
+ *  name: string;
+ *  sex: 'male' | 'female';
+ *  age: string
+ * }
+ */
+type MergeAll<
+  T extends object[],
+  R extends object = Record<string, any>,
+> = T extends [infer F extends object, ...infer Rest extends object[]]
+  ? MergeAll<Rest, Merge<R, F>>
+  : R;
+
+type EmitType = (name: Name, ...args: any[]) => void;
+
+type MaybePromise<T> = Promise<T> | T;
+
+export type {
+  AnyFunction,
+  AnyNormalFunction,
+  AnyPromiseFunction,
+  DeepPartial,
+  DeepReadonly,
+  EmitType,
+  IntervalHandle,
+  MaybeComputedRef,
+  MaybePromise,
+  MaybeReadonlyRef,
+  Merge,
+  MergeAll,
+  NonNullable,
+  Nullable,
+  ReadonlyRecordable,
+  Recordable,
+  TimeoutHandle,
+};

packages/@core/base/typings/src/index.ts

@@ -0,0 +1,6 @@
+export type * from './app';
+export type * from './basic';
+export type * from './helper';
+export type * from './menu-record';
+export type * from './tabs';
+export type * from './vue-router';

packages/@core/base/typings/src/menu-record.ts

@@ -0,0 +1,99 @@
+import type { Component } from 'vue';
+import type { RouteMeta, RouteRecordRaw } from 'vue-router';
+
+/** 路由元信息 */
+interface AppRouteRecordRaw extends Omit<RouteRecordRaw, 'meta'> {
+  children?: AppRouteRecordRaw[];
+  component?: any;
+  componentName?: string;
+  components?: any;
+  fullPath?: string;
+  icon?: string;
+  id?: any;
+  keepAlive?: boolean;
+  meta: RouteMeta;
+  name: string;
+  parentId?: number;
+  props?: any;
+  sort?: number;
+  visible?: boolean;
+}
+
+/**
+ * 扩展路由原始对象
+ */
+type ExRouteRecordRaw = RouteRecordRaw & {
+  parent?: string;
+  parents?: string[];
+  path?: any;
+};
+
+interface MenuRecordBadgeRaw {
+  /**
+   * 徽标
+   */
+  badge?: string;
+  /**
+   * 徽标类型
+   */
+  badgeType?: 'dot' | 'normal';
+  /**
+   * 徽标颜色
+   */
+  badgeVariants?: 'destructive' | 'primary' | string;
+}
+
+/**
+ * 菜单原始对象
+ */
+interface MenuRecordRaw extends MenuRecordBadgeRaw {
+  /**
+   * 激活时的图标名
+   */
+  activeIcon?: string;
+  /**
+   * 子菜单
+   */
+  children?: MenuRecordRaw[];
+  /**
+   * 是否禁用菜单
+   * @default false
+   */
+  disabled?: boolean;
+  /**
+   * 图标名
+   */
+  icon?: Component | string;
+  /**
+   * 菜单名
+   */
+  name: string;
+  /**
+   * 排序号
+   */
+  order?: number;
+  /**
+   * 父级路径
+   */
+  parent?: string;
+  /**
+   * 所有父级路径
+   */
+  parents?: string[];
+  /**
+   * 菜单路径，唯一，可当作key
+   */
+  path: string;
+  /**
+   * 是否显示菜单
+   * @default true
+   */
+  show?: boolean;
+}
+
+export type {
+  AppRouteRecordRaw,
+  ExRouteRecordRaw,
+  MenuRecordBadgeRaw,
+  MenuRecordRaw,
+};

packages/@core/base/typings/src/tabs.ts

@@ -0,0 +1,8 @@
+import type { RouteLocationNormalized } from 'vue-router';
+
+export interface TabDefinition extends RouteLocationNormalized {
+  /**
+   * 标签页的key
+   */
+  key?: string;
+}

packages/@core/base/typings/src/vue-router.d.ts

@@ -0,0 +1,153 @@
+import type { Component } from 'vue';
+import type { Router, RouteRecordRaw } from 'vue-router';
+
+interface RouteMeta {
+  /**
+   * 激活图标（菜单/tab）
+   */
+  activeIcon?: string;
+  /**
+   * 当前激活的菜单，有时候不想激活现有菜单，需要激活父级菜单时使用
+   */
+  activePath?: string;
+  /**
+   * 是否固定标签页
+   * @default false
+   */
+  affixTab?: boolean;
+  /**
+   * 固定标签页的顺序
+   * @default 0
+   */
+  affixTabOrder?: number;
+  /**
+   * 需要特定的角色标识才可以访问
+   * @default []
+   */
+  authority?: string[];
+  /**
+   * 徽标
+   */
+  badge?: string;
+  /**
+   * 徽标类型
+   */
+  badgeType?: 'dot' | 'normal';
+  /**
+   * 徽标颜色
+   */
+  badgeVariants?:
+    | 'default'
+    | 'destructive'
+    | 'primary'
+    | 'success'
+    | 'warning'
+    | string;
+  /**
+   * 路由的完整路径作为key（默认true）
+   */
+  fullPathKey?: boolean;
+  /**
+   * 当前路由的子级在菜单中不展现
+   * @default false
+   */
+  hideChildrenInMenu?: boolean;
+  /**
+   * 当前路由在面包屑中不展现
+   * @default false
+   */
+  hideInBreadcrumb?: boolean;
+  /**
+   * 当前路由在菜单中不展现
+   * @default false
+   */
+  hideInMenu?: boolean;
+  /**
+   * 当前路由在标签页不展现
+   * @default false
+   */
+  hideInTab?: boolean;
+  /**
+   * 图标（菜单/tab）
+   */
+  icon?: Component | string;
+  /**
+   * iframe 地址
+   */
+  iframeSrc?: string;
+  /**
+   * 忽略权限，直接可以访问
+   * @default false
+   */
+  ignoreAccess?: boolean;
+  /**
+   * 开启KeepAlive缓存
+   */
+  keepAlive?: boolean;
+  /**
+   * 外链-跳转路径
+   */
+  link?: string;
+  /**
+   * 路由是否已经加载过
+   */
+  loaded?: boolean;
+  /**
+   * 标签页最大打开数量
+   * @default -1
+   */
+  maxNumOfOpenTab?: number;
+  /**
+   * 菜单可以看到，但是访问会被重定向到403
+   */
+  menuVisibleWithForbidden?: boolean;
+  /**
+   * 不使用基础布局（仅在顶级生效）
+   */
+  noBasicLayout?: boolean;
+  /**
+   * 在新窗口打开
+   */
+  openInNewWindow?: boolean;
+  /**
+   * 用于路由->菜单排序
+   */
+  order?: number;
+  /**
+   * 菜单所携带的参数
+   */
+  query?: Recordable;
+  /**
+   * 标题名称
+   */
+  title: string;
+}
+
+// 定义递归类型以将 RouteRecordRaw 的 component 属性更改为 string
+type RouteRecordStringComponent<T = string> = Omit<
+  RouteRecordRaw,
+  'children' | 'component'
+> & {
+  children?: RouteRecordStringComponent<T>[];
+  component: T;
+};
+
+type ComponentRecordType = Record<string, () => Promise<Component>>;
+
+interface GenerateMenuAndRoutesOptions {
+  fetchMenuListAsync?: () => Promise<RouteRecordStringComponent[]>;
+  forbiddenComponent?: RouteRecordRaw['component'];
+  layoutMap?: ComponentRecordType;
+  pageMap?: ComponentRecordType;
+  roles?: string[];
+  router: Router;
+  routes: RouteRecordRaw[];
+}
+
+export type {
+  ComponentRecordType,
+  GenerateMenuAndRoutesOptions,
+  RouteMeta,
+  RouteRecordRaw,
+  RouteRecordStringComponent,
+};

packages/@core/base/typings/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "@vben/tsconfig/library.json",
+  "include": ["src"],
+  "exclude": ["node_modules"]
+}

packages/@core/base/typings/vue-router.d.ts

@@ -0,0 +1,9 @@
+/* eslint-disable no-restricted-imports */
+import type { RouteMeta as IRouteMeta } from '@vben-core/typings';
+
+import 'vue-router';
+
+declare module 'vue-router' {
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+  interface RouteMeta extends IRouteMeta {}
+}