create-koa-boot 1.0.0

package/templates/example/frontend/src/api/business/logistics.ts

@@ -0,0 +1,167 @@
+import service from '../service'
+import type { ResponseResult, PaginationResult, PaginationParams } from '../common'
+
+// ==================== 运单（V4.0 替代发货批次） ====================
+
+export interface WaybillItemInfo {
+  id: string
+  waybillId: string
+  skuId: string
+  quantity: number
+  createdAt: string
+  /** 明细 SKU 信息（详情/打印接口返回） */
+  sku?: { skuCode: string; skuName: string; spec?: string | null; unit?: string | null }
+}
+
+export interface WaybillReceiptInfo {
+  id: string
+  waybillId: string
+  /** 运单编号（列表接口联表返回，运单不存在时为 null） */
+  waybillNo: string | null
+  skuId: string
+  signedQuantity: number
+  isException: boolean
+  exceptionType: string | null
+  signedBy: string | null
+  signedAt: string
+  remark: string | null
+  createdAt: string
+  /** 明细 SKU 信息（详情/打印接口返回） */
+  sku?: { skuCode: string; skuName: string; spec?: string | null; unit?: string | null }
+  /** 所属运单（详情/打印接口返回） */
+  waybill?: { waybillNo: string; store?: { storeName: string } | null; toWarehouse?: { warehouseName: string } | null }
+}
+
+export interface WaybillInfo {
+  id: string
+  waybillNo: string
+  /** 来源类型：warehouse_outbound-销售/调拨出库 purchase-数据入库采购 */
+  sourceType: string
+  sourceId: string
+  outboundId: string | null
+  storeId: string | null
+  toWarehouseId: string | null
+  carrier: string | null
+  trackingNo: string | null
+  logisticsStatus: string | null
+  /** pending-待发货 shipped-已发货 received-已签收 partial_received-部分签收 exception-异常 */
+  status: string | null
+  shippedAt: string | null
+  receivedAt: string | null
+  expectedArrival: string | null
+  createdAt: string
+  updatedAt: string
+  items?: WaybillItemInfo[]
+  receipts?: WaybillReceiptInfo[]
+  /** 收货门店（详情/打印接口返回） */
+  store?: { storeName: string; address?: string | null }
+  /** 收货仓库（详情/打印接口返回） */
+  toWarehouse?: { warehouseName: string; address?: string | null }
+  /** 关联出库单（详情/打印接口返回） */
+  outbound?: { outboundNo: string }
+}
+
+export const getWaybillList = (
+  params: PaginationParams & {
+    keyword?: string
+    sourceType?: string
+    storeId?: string
+    toWarehouseId?: string
+    status?: string
+  }
+) => {
+  return service.get<ResponseResult<PaginationResult<WaybillInfo>>>('/logistics/waybills/page', { params })
+}
+
+/** 导出运单列表 Excel（按当前筛选条件，xlsx 文件流） */
+export const exportWaybillsExcel = (params: {
+  keyword?: string
+  sourceType?: string
+  storeId?: string
+  toWarehouseId?: string
+  status?: string
+}) => {
+  return service.get<Blob>('/logistics/waybills/export', { params, responseType: 'blob' })
+}
+
+export const getWaybillDetail = (id: string) => {
+  return service.get<ResponseResult<WaybillInfo>>(`/logistics/waybills/${id}`)
+}
+
+export const getWaybillByNo = (waybillNo: string) => {
+  return service.get<ResponseResult<WaybillInfo>>(`/logistics/waybills/no/${waybillNo}`)
+}
+
+/** 创建运单（多态来源：销售/调拨出库关联出库单，数据入库关联采购单） */
+export const createWaybill = (data: {
+  sourceType: string
+  sourceId: string
+  outboundId?: string | null
+  storeId?: string | null
+  toWarehouseId?: string | null
+  carrier?: string
+  trackingNo?: string
+  expectedArrival?: string
+  items: { skuId: string; quantity: number }[]
+}) => {
+  return service.post<ResponseResult<WaybillInfo>>('/logistics/waybills', data)
+}
+
+/** 更新运单物流信息（承运商/物流单号/物流状态/运单状态/预计到达） */
+export const updateWaybillLogistics = (
+  id: string,
+  data: {
+    carrier?: string
+    trackingNo?: string
+    logisticsStatus?: string
+    status?: string
+    expectedArrival?: string
+  }
+) => {
+  return service.put<ResponseResult<WaybillInfo>>(`/logistics/waybills/${id}/logistics`, data)
+}
+
+/** 运单发货（pending → shipped） */
+export const shipWaybill = (id: string) => {
+  return service.put<ResponseResult<WaybillInfo>>(`/logistics/waybills/${id}/ship`, {})
+}
+
+/** 运单签收（按 SKU 逐行录入实收，支持多次部分签收；调拨/数据入库自动累加收货仓库存） */
+export const receiveWaybill = (
+  id: string,
+  data: {
+    items: { skuId: string; signedQuantity: number; exceptionType?: string; remark?: string }[]
+    signedBy?: string
+    remark?: string
+  }
+) => {
+  return service.post<ResponseResult<WaybillReceiptInfo[]>>(`/logistics/waybills/${id}/receive`, data)
+}
+
+// ==================== 运单签收记录 ====================
+
+export const getWaybillReceiptList = (
+  params: PaginationParams & { waybillId?: string; isException?: boolean }
+) => {
+  return service.get<ResponseResult<PaginationResult<WaybillReceiptInfo>>>('/logistics/waybills/receipts/page', {
+    params,
+  })
+}
+
+/** 导出签收单列表 Excel（按当前筛选条件，xlsx 文件流） */
+export const exportWaybillsReceiptsExcel = (params: {
+  keyword?: string
+  waybillId?: string
+  isException?: boolean
+}) => {
+  return service.get<Blob>('/logistics/waybills/receipts/export', { params, responseType: 'blob' })
+}
+
+/** 查询某运单的签收记录 */
+export const getReceiptsByWaybill = (waybillId: string) => {
+  return service.get<ResponseResult<WaybillReceiptInfo[]>>(`/logistics/waybills/receipts/waybill/${waybillId}`)
+}
+
+export const getWaybillReceiptDetail = (id: string) => {
+  return service.get<ResponseResult<WaybillReceiptInfo>>(`/logistics/waybills/receipts/${id}`)
+}

package/templates/example/frontend/src/api/business/notification.ts

@@ -0,0 +1,54 @@
+import service from '../service'
+import type { ResponseResult, PaginationResult, PaginationParams } from '../common'
+
+// ==================== 消息通知（V5.4） ====================
+
+/** 消息类型：TODO-待办 PROGRESS-进度 WARNING-预警 */
+export type MessageType = 'TODO' | 'PROGRESS' | 'WARNING'
+
+/** 消息跳转参数（点击消息后路由跳转） */
+export interface MessageJump {
+  path: string
+  query?: Record<string, string>
+}
+
+export interface MessageInfo {
+  id: string
+  msgType: MessageType
+  title: string
+  content: string
+  templateCode: string
+  receiverUserId: string
+  receiverRoleCode: string | null
+  operatorId: string | null
+  isRead: boolean
+  readTime: string | null
+  bizType: string
+  bizId: string | null
+  bizId2: string | null
+  /** 跳转参数（后端扁平化自 extraData） */
+  jump: MessageJump | null
+  createdAt: string
+}
+
+/** 分页查询当前用户消息（msgType/isRead 筛选） */
+export const getMessagePage = (
+  params: PaginationParams & { msgType?: MessageType; isRead?: boolean }
+) => {
+  return service.get<ResponseResult<PaginationResult<MessageInfo>>>('/notification/page', { params })
+}
+
+/** 未读消息数（顶栏红点轮询） */
+export const getUnreadCount = () => {
+  return service.get<ResponseResult<{ count: number }>>('/notification/unread-count')
+}
+
+/** 标记单条消息已读 */
+export const markMessageRead = (id: string) => {
+  return service.patch<ResponseResult<boolean>>(`/notification/${id}/read`)
+}
+
+/** 全部标记已读 */
+export const markAllMessageRead = () => {
+  return service.patch<ResponseResult<{ count: number }>>('/notification/read-all')
+}

package/templates/example/frontend/src/api/business/sysConfig.ts

@@ -0,0 +1,54 @@
+import service from '../service'
+import type { ResponseResult } from '../common'
+
+// ==================== 全局参数（base/configs） ====================
+
+export interface SysConfigInfo {
+  id: string
+  configKey: string
+  configValue: string
+  description: string | null
+  createdAt: string
+  updatedAt: string
+}
+
+export interface CreateSysConfigDto {
+  configKey: string
+  configValue: string
+  description?: string
+}
+
+export interface UpdateSysConfigDto {
+  configValue?: string
+  description?: string
+}
+
+/** 全部参数列表 */
+export const getConfigList = () => {
+  return service.get<ResponseResult<SysConfigInfo[]>>('/base/configs')
+}
+
+/** 按 key 查询 */
+export const getConfigByKey = (configKey: string) => {
+  return service.get<ResponseResult<SysConfigInfo | null>>(`/base/configs/key/${configKey}`)
+}
+
+/** 详情 */
+export const getConfigDetail = (id: string) => {
+  return service.get<ResponseResult<SysConfigInfo | null>>(`/base/configs/${id}`)
+}
+
+/** 创建 */
+export const createConfig = (data: CreateSysConfigDto) => {
+  return service.post<ResponseResult<SysConfigInfo | null>>('/base/configs', data)
+}
+
+/** 更新（参数键不允许修改） */
+export const updateConfig = (id: string, data: UpdateSysConfigDto) => {
+  return service.put<ResponseResult<SysConfigInfo | null>>(`/base/configs/${id}`, data)
+}
+
+/** 删除 */
+export const deleteConfig = (id: string) => {
+  return service.delete<ResponseResult<boolean>>(`/base/configs/${id}`)
+}

package/templates/example/frontend/src/api/common.ts

@@ -0,0 +1,23 @@
+export interface PaginationParams {
+  page: number
+  pageSize: number
+  keyword?: string
+}
+
+export interface PaginationResult<T> {
+  list: T[]
+  pagination: {
+    page: number
+    pageSize: number
+    total: number
+    totalPages: number
+    hasPrev: boolean
+    hasNext: boolean
+  }
+}
+
+export interface ResponseResult<T> {
+  code: number
+  message: string
+  data: T
+}

package/templates/example/frontend/src/api/index.ts

@@ -0,0 +1,31 @@
+export { login, logout, getUserInfo, getCurrentUser } from './auth'
+
+export { getUserList, getUserDetail, createUser, updateUser, deleteUser } from './system/user'
+export type { UserInfo } from './system/user'
+
+export { getRoleList, getAllRoles, getRoleDetail, createRole, updateRole, deleteRole, assignRolePermissions, getRolePermissionIds } from './system/role'
+export type { RoleInfo } from './system/role'
+
+export { getPermissionList, getPermissionTree, getPermissionDetail, createPermission, updatePermission, deletePermission } from './system/permission'
+export type { PermissionInfo } from './system/permission'
+
+export { getDepartmentList, getDepartmentTree, getDepartmentDetail, createDepartment, updateDepartment, deleteDepartment } from './system/department'
+export type { DepartmentInfo } from './system/department'
+
+export { getDictTypeList, getDictTypeDetail, createDictType, updateDictType, deleteDictType, getDictItemList, getDictItemDetail, createDictItem, updateDictItem, deleteDictItem, getDictItemsByType } from './system/dict'
+export type { DictTypeInfo, DictItemInfo } from './system/dict'
+
+export { getMenuTree, getMenuList, getMenuDetail, createMenu, updateMenu, deleteMenu } from './system/menu'
+export type { MenuInfo } from './system/menu'
+
+export { getOperationLogList, deleteOperationLog, clearOperationLogs, getLoginLogList, deleteLoginLog, clearLoginLogs } from './system/log'
+export type { OperationLogInfo, LoginLogInfo } from './system/log'
+
+export * from './business/demo'
+export * from './business/sysConfig'
+export * from './business/notification'
+export * from './ai'
+
+export type { PaginationParams, PaginationResult, ResponseResult } from './common'
+
+export { default as service } from './service'

package/templates/example/frontend/src/api/service.ts

@@ -0,0 +1,47 @@
+import axios from 'axios'
+import { transformDateTimeFields } from '../utils/dateFormat'
+
+const service = axios.create({
+  baseURL: '/api',
+  timeout: 10000,
+  headers: {
+    'Content-Type': 'application/json'
+  }
+})
+
+service.interceptors.request.use(
+  config => {
+    const token = localStorage.getItem('token')
+    if (token) {
+      config.headers.Authorization = `Bearer ${token}`
+    }
+    return config
+  },
+  error => {
+    console.error('请求错误:', error)
+    return Promise.reject(error)
+  }
+)
+
+service.interceptors.response.use(
+  response => {
+    // 二进制文件流（如导出Excel）直接放行，不做业务码校验
+    if (response.config.responseType === 'blob') {
+      return response
+    }
+    const res = response.data
+    if (res.code !== 200) {
+      console.error('响应错误:', res.message)
+      return Promise.reject(new Error(res.message || 'Error'))
+    }
+    // 统一格式化响应中的时间字段（递归转换业务数据）
+    transformDateTimeFields(res)
+    return response
+  },
+  error => {
+    console.error('响应错误:', error)
+    return Promise.reject(error)
+  }
+)
+
+export default service

package/templates/example/frontend/src/api/system/department.ts

@@ -0,0 +1,40 @@
+import service from '../service'
+import type { ResponseResult, PaginationResult, PaginationParams } from '../common'
+
+export interface DepartmentInfo {
+  id: string
+  name: string
+  code: string
+  parentId: string
+  leaderId: string
+  phone: string
+  sort: number
+  status: string
+  createdAt: string
+  updatedAt: string
+  children?: DepartmentInfo[]
+}
+
+export const getDepartmentList = (params: PaginationParams) => {
+  return service.get<ResponseResult<PaginationResult<DepartmentInfo>>>('/system/department/search/page', { params })
+}
+
+export const getDepartmentTree = () => {
+  return service.get<ResponseResult<DepartmentInfo[]>>('/system/department/tree')
+}
+
+export const getDepartmentDetail = (id: string) => {
+  return service.get<ResponseResult<DepartmentInfo>>(`/system/department/${id}`)
+}
+
+export const createDepartment = (data: any) => {
+  return service.post<ResponseResult<DepartmentInfo>>('/system/department', data)
+}
+
+export const updateDepartment = (id: string, data: any) => {
+  return service.put<ResponseResult<DepartmentInfo>>(`/system/department/${id}`, data)
+}
+
+export const deleteDepartment = (id: string) => {
+  return service.delete<ResponseResult<null>>(`/system/department/${id}`)
+}

package/templates/example/frontend/src/api/system/dict.ts

@@ -0,0 +1,124 @@
+import service from '../service'
+import type { ResponseResult, PaginationResult, PaginationParams } from '../common'
+
+export interface DictTypeInfo {
+  id: string
+  code: string
+  name: string
+  description: string
+  status: string
+  createdAt: string
+  updatedAt: string
+}
+
+export interface DictItemInfo {
+  id: string
+  typeId: string
+  typeCode?: string
+  typeName?: string
+  label: string
+  value: string
+  cssClass: string
+  sort: number
+  status: string
+  description: string
+  createdAt: string
+  updatedAt: string
+}
+
+export const getDictTypeList = (params: PaginationParams) => {
+  return service.get<ResponseResult<PaginationResult<DictTypeInfo>>>('/system/dict-type/search/page', { params })
+}
+
+export const getDictTypeDetail = (id: string) => {
+  return service.get<ResponseResult<DictTypeInfo>>(`/system/dict-type/${id}`)
+}
+
+export const createDictType = (data: any) => {
+  return service.post<ResponseResult<DictTypeInfo>>('/system/dict-type', data)
+}
+
+export const updateDictType = (id: string, data: any) => {
+  return service.put<ResponseResult<DictTypeInfo>>(`/system/dict-type/${id}`, data)
+}
+
+export const deleteDictType = (id: string) => {
+  return service.delete<ResponseResult<null>>(`/system/dict-type/${id}`)
+}
+
+export const getDictItemList = (params: PaginationParams & { typeId?: string; typeCode?: string }) => {
+  return service.get<ResponseResult<PaginationResult<DictItemInfo>>>('/system/dict-item/search/page', { params })
+}
+
+export const getDictItemDetail = (id: string) => {
+  return service.get<ResponseResult<DictItemInfo>>(`/system/dict-item/${id}`)
+}
+
+export const createDictItem = (data: any) => {
+  return service.post<ResponseResult<DictItemInfo>>('/system/dict-item', data)
+}
+
+export const updateDictItem = (id: string, data: any) => {
+  return service.put<ResponseResult<DictItemInfo>>(`/system/dict-item/${id}`, data)
+}
+
+export const deleteDictItem = (id: string) => {
+  return service.delete<ResponseResult<null>>(`/system/dict-item/${id}`)
+}
+
+export const getDictItemsByType = (typeCode: string) => {
+  return service.get<ResponseResult<DictItemInfo[]>>(`/system/dict-item/type-code/${typeCode}`)
+}
+
+// ============ 字典树（登录后全局缓存用） ============
+
+/** 字典数据节点（精简版，仅保留前端渲染所需字段） */
+export interface DictTreeNode {
+  id: string
+  typeId: string
+  label: string
+  value: string
+  cssClass: string | null
+  sort: number
+  status: string
+  description: string | null
+}
+
+/** 字典类型树节点（含子项列表） */
+export interface DictTypeTreeNode {
+  id: string
+  code: string
+  name: string
+  description: string | null
+  status: string
+  items: DictTreeNode[]
+  createdAt: string
+  updatedAt: string
+}
+
+/** 分页获取字典类型树（含字典项），登录后缓存到 store */
+export const getDictTypeTree = () => {
+  return service.get<ResponseResult<{
+    list: DictTypeTreeNode[]
+    pagination: { page: number; pageSize: number; total: number; totalPages: number; hasPrev: boolean; hasNext: boolean }
+  }>>('/system/dict-type/tree/page', { params: { page: 1, pageSize: 1000 } })
+}
+
+// ============ Store 存储格式 ============
+
+/** 字典项按 value 索引的映射表 */
+export type DictItemMap = Record<string, DictTreeNode>
+
+/**
+ * 重构后的字典树 store 存储格式。
+ * 
+ * 每个字典类型生成两个 key：
+ * - `{code}_Object` → DictItemMap   按 value 索引单项（O(1) 查找）
+ * - `{code}_Array`  → DictTreeNode[]  按 sort 排序的数组（用于下拉选项）
+ * 
+ * @example
+ * store.dictTree['soil_type_Array']  // [{label:'壤土',value:'loam'}, ...]
+ * store.dictTree['soil_type_Object'] // { loam: {label:'壤土',...}, sand: {...} }
+ * store.dictTree['soil_type_Object']['loam']?.label  // → '壤土'
+ */
+export type DictTreeStore = Record<string, DictItemMap | DictTreeNode[]>

package/templates/example/frontend/src/api/system/fileUpload.ts

@@ -0,0 +1,64 @@
+import service from '../service'
+import type { ResponseResult } from '../common'
+
+/**
+ * 文件上传记录（后端返回的数据结构）
+ */
+export interface FileRecord {
+  id: string
+  fileNo: string
+  name: string
+  size: number
+  type: string
+  url: string
+  description?: string
+  createdAt: string
+  updatedAt: string
+}
+
+/**
+ * 上传组件的 v-model 数据结构
+ */
+export interface UploadFileInfo {
+  /** 文件显示名称 */
+  name: string
+  /** 文件访问 URL */
+  url: string
+  /** 文件编号 */
+  fileNo?: string
+}
+
+/**
+ * 上传文件（直接使用 el-upload 的 action 属性，无需调用此函数）
+ * 后端接口: POST /api/system/file-upload (multipart/form-data, field: file)
+ */
+export const UPLOAD_URL = '/api/system/file-upload'
+export const UPLOAD_FIELD_NAME = 'file'
+
+/**
+ * 删除已上传文件
+ * @param id 文件记录 ID
+ */
+export function deleteFile(id: string): Promise<ResponseResult<boolean>> {
+  return service.delete(`/system/file-upload/${id}`)
+}
+
+/**
+ * 上传成功响应的类型（el-upload on-success 回调参数）
+ */
+export interface UploadSuccessResponse {
+  code: number
+  message: string
+  data: FileRecord
+}
+
+/**
+ * 批量查询文件详情（根据 fileNo 列表）
+ * 后端接口: GET /api/system/file-upload/batch?fileNos=xxx,yyy
+ */
+export function getFilesByFileNos(fileNos: string[]) {
+  const nos = fileNos.filter(Boolean).join(',')
+  return service.get<ResponseResult<FileRecord[]>>('/system/file-upload/batch', {
+    params: { fileNos: nos }
+  })
+}

package/templates/example/frontend/src/api/system/log.ts

@@ -0,0 +1,63 @@
+import service from '../service'
+import type { ResponseResult, PaginationResult, PaginationParams } from '../common'
+
+export interface OperationLogInfo {
+  id: string
+  userId: string
+  username: string
+  module: string
+  action: string
+  targetType: string
+  targetId: string
+  description: string
+  requestMethod: string
+  requestUrl: string
+  requestIp: string
+  requestBody: string
+  responseCode: number
+  duration: number
+  status: string
+  errorMsg: string
+  createdAt: string
+}
+
+export interface LoginLogInfo {
+  id: string
+  userId: string
+  username: string
+  action: string
+  ip: string
+  userAgent: string
+  os: string
+  browser: string
+  status: string
+  message: string
+  createdAt: string
+}
+
+export const getOperationLogList = (params: PaginationParams & { module?: string; action?: string }) => {
+  return service.get<ResponseResult<PaginationResult<OperationLogInfo>>>('/system/operation-log/search/page', { params })
+}
+
+/** 单条删除操作日志：后端暂未提供对应接口，保留占位 */
+export const deleteOperationLog = (id: string) => {
+  return service.delete<ResponseResult<null>>(`/system/operation-log/delete/${id}`)
+}
+
+/** 清空操作日志：后端暂未提供对应接口，保留占位 */
+export const clearOperationLogs = () => {
+  return service.delete<ResponseResult<null>>('/system/operation-log/clear')
+}
+
+export const getLoginLogList = (params: PaginationParams & { username?: string; status?: string }) => {
+  return service.get<ResponseResult<PaginationResult<LoginLogInfo>>>('/system/login-log/search/page', { params })
+}
+
+export const deleteLoginLog = (id: string) => {
+  return service.delete<ResponseResult<null>>(`/system/login-log/${id}`)
+}
+
+/** 清空/批量删除登录日志：后端接口为 POST /system/login-log/batch { ids: string[] } */
+export const clearLoginLogs = () => {
+  return service.delete<ResponseResult<null>>('/system/login-log/clear')
+}