物业代码生成

apps/web-antd/src/api/core/auth.ts

@@ -0,0 +1,204 @@
+import type { GrantType } from '@vben/common-ui';
+import type { HttpResponse } from '@vben/request';
+
+import { h } from 'vue';
+
+import { useAppConfig } from '@vben/hooks';
+
+import { Modal } from 'ant-design-vue';
+
+import { requestClient } from '#/api/request';
+
+const { clientId, sseEnable } = useAppConfig(
+  import.meta.env,
+  import.meta.env.PROD,
+);
+
+export namespace AuthApi {
+  /**
+   * @description: 所有登录类型都需要用到的
+   * @param clientId 客户端ID 这里为必填项 但是在loginApi内部处理了 所以为可选
+   * @param grantType 授权/登录类型
+   * @param tenantId 租户id
+   */
+  export interface BaseLoginParams {
+    clientId?: string;
+    grantType: GrantType;
+    tenantId: string;
+  }
+
+  /**
+   * @description: oauth登录需要用到的参数
+   * @param socialCode 第三方参数
+   * @param socialState 第三方参数
+   * @param source 与后端的 justauth.type.xxx的回调地址的source对应
+   */
+  export interface OAuthLoginParams extends BaseLoginParams {
+    socialCode: string;
+    socialState: string;
+    source: string;
+  }
+
+  /**
+   * @description: 验证码登录需要用到的参数
+   * @param code 验证码 可选(未开启验证码情况)
+   * @param uuid 验证码ID 可选(未开启验证码情况)
+   * @param username 用户名
+   * @param password 密码
+   */
+  export interface SimpleLoginParams extends BaseLoginParams {
+    code?: string;
+    uuid?: string;
+    username: string;
+    password: string;
+  }
+
+  export type LoginParams = OAuthLoginParams | SimpleLoginParams;
+
+  // /** 登录接口参数 */
+  // export interface LoginParams {
+  //   code?: string;
+  //   grantType: string;
+  //   password: string;
+  //   tenantId: string;
+  //   username: string;
+  //   uuid?: string;
+  // }
+
+  /** 登录接口返回值 */
+  export interface LoginResult {
+    access_token: string;
+    client_id: string;
+    expire_in: number;
+  }
+
+  export interface RefreshTokenResult {
+    data: string;
+    status: number;
+  }
+}
+
+/**
+ * 登录
+ */
+export async function loginApi(data: AuthApi.LoginParams) {
+  return requestClient.post<AuthApi.LoginResult>(
+    '/auth/login',
+    { ...data, clientId },
+    {
+      encrypt: true,
+    },
+  );
+}
+
+/**
+ * 用户登出
+ * @returns void
+ */
+export async function doLogout() {
+  const resp = await requestClient.post<HttpResponse<void>>(
+    '/auth/logout',
+    null,
+    {
+      isTransformResponse: false,
+    },
+  );
+  // 无奈之举 对错误用法的提示
+  if (resp.code === 401 && import.meta.env.DEV) {
+    Modal.destroyAll();
+    Modal.warn({
+      title: '后端配置出现错误',
+      centered: true,
+      content: h('div', { class: 'flex flex-col gap-2' }, [
+        `检测到你的logout接口返回了401, 导致前端一直进入循环逻辑???`,
+        ...Array.from({ length: 3 }, () =>
+          h(
+            'span',
+            { class: 'font-bold text-red-500 text-[18px]' },
+            '去检查你的后端配置!别盯着前端找问题了!这不是前端问题!',
+          ),
+        ),
+      ]),
+    });
+  }
+}
+
+/**
+ * 关闭sse连接
+ * @returns void
+ */
+export function seeConnectionClose() {
+  /**
+   * 未开启sse 不需要处理
+   */
+  if (!sseEnable) {
+    return;
+  }
+  return requestClient.get<void>('/resource/sse/close');
+}
+
+/**
+ * @param companyName 租户/公司名称
+ * @param domain 绑定域名(不带http(s)://) 可选
+ * @param tenantId 租户id
+ */
+export interface TenantOption {
+  companyName: string;
+  domain?: string;
+  tenantId: string;
+}
+
+/**
+ * @param tenantEnabled 是否启用租户
+ * @param voList 租户列表
+ */
+export interface TenantResp {
+  tenantEnabled: boolean;
+  voList: TenantOption[];
+}
+
+/**
+ * 获取租户列表 下拉框使用
+ */
+export function tenantList() {
+  return requestClient.get<TenantResp>('/auth/tenant/list');
+}
+
+/**
+ * vben的 先不删除
+ * @returns string[]
+ */
+export async function getAccessCodesApi() {
+  return requestClient.get<string[]>('/auth/codes');
+}
+
+/**
+ * 绑定第三方账号
+ * @param source 绑定的来源
+ * @returns 跳转url
+ */
+export function authBinding(source: string, tenantId: string) {
+  return requestClient.get<string>(`/auth/binding/${source}`, {
+    params: {
+      domain: window.location.host,
+      tenantId,
+    },
+  });
+}
+
+/**
+ * 取消绑定
+ * @param id id
+ */
+export function authUnbinding(id: string) {
+  return requestClient.deleteWithMsg<void>(`/auth/unlock/${id}`);
+}
+
+/**
+ * oauth授权回调
+ * @param data oauth授权
+ * @returns void
+ */
+export function authCallback(data: AuthApi.OAuthLoginParams) {
+  return requestClient.post<void>('/auth/social/callback', data);
+}

apps/web-antd/src/api/core/captcha.ts

@@ -0,0 +1,42 @@
+import { requestClient } from '#/api/request';
+
+/**
+ * 发送短信验证码
+ * @param phonenumber 手机号
+ * @returns void
+ */
+export function sendSmsCode(phonenumber: string) {
+  return requestClient.get<void>('/resource/sms/code', {
+    params: { phonenumber },
+  });
+}
+
+/**
+ * 发送邮件验证码
+ * @param email 邮箱
+ * @returns void
+ */
+export function sendEmailCode(email: string) {
+  return requestClient.get<void>('/resource/email/code', {
+    params: { email },
+  });
+}
+
+/**
+ * @param img 图片验证码 需要和base64拼接
+ * @param captchaEnabled 是否开启
+ * @param uuid 验证码ID
+ */
+export interface CaptchaResponse {
+  captchaEnabled: boolean;
+  img: string;
+  uuid: string;
+}
+
+/**
+ * 图片验证码
+ * @returns resp
+ */
+export function captchaImage() {
+  return requestClient.get<CaptchaResponse>('/auth/code');
+}

apps/web-antd/src/api/core/index.ts

@@ -0,0 +1,4 @@
+export * from './auth';
+export * from './menu';
+export * from './upload';
+export * from './user';

apps/web-antd/src/api/core/menu.ts

@@ -0,0 +1,45 @@
+import { requestClient } from '#/api/request';
+
+/**
+ * @description: 菜单meta
+ * @param title 菜单名
+ * @param icon 菜单图标
+ * @param noCache 是否不缓存
+ * @param link 外链链接
+ */
+export interface MenuMeta {
+  icon: string;
+  link?: string;
+  noCache: boolean;
+  title: string;
+}
+
+/**
+ * @description: 菜单
+ * @param name 菜单名
+ * @param path 菜单路径
+ * @param hidden 是否隐藏
+ * @param component 组件名称 Layout
+ * @param alwaysShow 总是显示
+ * @param query 路由参数(json形式)
+ * @param meta 路由信息
+ * @param children 子路由信息
+ */
+export interface Menu {
+  alwaysShow?: boolean;
+  children: Menu[];
+  component: string;
+  hidden: boolean;
+  meta: MenuMeta;
+  name: string;
+  path: string;
+  query?: string;
+  redirect?: string;
+}
+
+/**
+ * 获取用户所有菜单
+ */
+export async function getAllMenusApi() {
+  return requestClient.get<Menu[]>('/system/menu/getRouters');
+}

apps/web-antd/src/api/core/upload.ts

@@ -0,0 +1,47 @@
+import type { AxiosRequestConfig } from '@vben/request';
+
+import { requestClient } from '#/api/request';
+
+/**
+ * Axios上传进度事件
+ */
+export type AxiosProgressEvent = AxiosRequestConfig['onUploadProgress'];
+
+/**
+ * 默认上传结果
+ */
+export interface UploadResult {
+  url: string;
+  fileName: string;
+  ossId: string;
+}
+
+/**
+ * 通过单文件上传接口
+ * @param file 上传的文件
+ * @param options 一些配置项
+ * @param options.onUploadProgress 上传进度事件
+ * @param options.signal 上传取消信号
+ * @param options.otherData 其他请求参数 后端拓展可能会用到
+ * @returns 上传结果
+ */
+export function uploadApi(
+  file: Blob | File,
+  options?: {
+    onUploadProgress?: AxiosProgressEvent;
+    otherData?: Record<string, any>;
+    signal?: AbortSignal;
+  },
+) {
+  const { onUploadProgress, signal, otherData = {} } = options ?? {};
+  return requestClient.upload<UploadResult>(
+    '/resource/oss/upload',
+    { file, ...otherData },
+    { onUploadProgress, signal, timeout: 60_000 },
+  );
+}
+
+/**
+ * 上传api type
+ */
+export type UploadApi = typeof uploadApi;

apps/web-antd/src/api/core/user.ts

@@ -0,0 +1,46 @@
+import { requestClient } from '#/api/request';
+
+export interface Role {
+  dataScope: string;
+  flag: boolean;
+  roleId: number;
+  roleKey: string;
+  roleName: string;
+  roleSort: number;
+  status: string;
+  superAdmin: boolean;
+}
+
+export interface User {
+  avatar: string;
+  createTime: string;
+  deptId: number;
+  deptName: string;
+  email: string;
+  loginDate: string;
+  loginIp: string;
+  nickName: string;
+  phonenumber: string;
+  remark: string;
+  roles: Role[];
+  sex: string;
+  status: string;
+  tenantId: string;
+  userId: number;
+  userName: string;
+  userType: string;
+}
+
+export interface UserInfoResp {
+  permissions: string[];
+  roles: string[];
+  user: User;
+}
+
+/**
+ * 获取用户信息
+ * 存在返回null的情况(401) 不会抛出异常 需要手动抛异常
+ */
+export async function getUserInfoApi() {
+  return requestClient.get<null | UserInfoResp>('/system/user/getInfo');
+}