diff --git a/src/api/dashboard/dashboard.ts b/src/api/dashboard/dashboard.ts index bcbcbeca..91611a28 100644 --- a/src/api/dashboard/dashboard.ts +++ b/src/api/dashboard/dashboard.ts @@ -15,52 +15,168 @@ export function getDashboardData(method: string, data: any) { } as any) } +/** dashboard.* 通用响应信封(业务字段与信封同级:flag/code/message/data/timestamp) */ +export type DashboardEnvelope = { + /** 结果标记,成功为 success */ + flag?: string + /** 业务码,成功为 200 */ + code?: number + message?: string + /** 服务器时间戳(秒) */ + timestamp?: number + data: T +} + +/** dashboard.storeStats 的 data(仓库发货统计;货主端自动跨已签约仓库汇总) */ +export type DashboardStoreStatsData = { + /** 今日订单数(待处理 + 今日已出库) */ + todayOrders: number + /** 今日新增较昨日增长率(%),昨日为 0 时按 100 或 0 计算 */ + orderTrend: number + /** 未分配快递号订单数 */ + unassignedOrders: number + /** 未打印订单数 */ + unprintedOrders: number + /** 未拣货订单数 */ + unpickedOrders: number + /** 待发货订单数 */ + pendingShipments: number + /** 发货进度(%),(待处理-待发货)/待处理 */ + shipmentProgress: number + /** 今日已出库订单数 */ + todayOutbound: number + /** 出库完成率(%),今日出库/(待发货+今日出库) */ + outboundRate: number + /** 拦截订单数 */ + interceptedOrders: number + /** 异常订单数(step=3) */ + exceptionOrders: number + /** 已复核订单数 */ + recheckedOrders: number + /** 已打包订单数 */ + packedOrders: number +} + /** - * 获取仓库基础统计数据 + * dashboard.warehouseStats 的 data(**固定演示数据**,非实时查询结果,仅供前端展示与调试)。 + * ⚠️ 字段少于 storeStats:**不含** recheckedOrders / packedOrders。 */ -export function getWarehouseStats(data: any = {}) { +export type DashboardWarehouseStatsData = { + todayOrders: number + orderTrend: number + unassignedOrders: number + unprintedOrders: number + unpickedOrders: number + pendingShipments: number + shipmentProgress: number + todayOutbound: number + outboundRate: number + interceptedOrders: number + exceptionOrders: number +} + +/** dashboard.express_ratio / platform_distribution 的 data 元素(饼图,按订单数降序) */ +export type DashboardPieItem = { + /** 快递公司名称(未填写时为「未指定快递」)/ 平台名称(未填写时为「未指定平台」) */ + name: string + /** 该名称下的待处理订单数 */ + value: number + /** 图表配色 */ + itemStyle?: { color?: string } +} + +/** dashboard.hot_order_rank 的 data 元素(今日销量 Top10,name 已脱敏) */ +export type DashboardHotOrderRankItem = { + /** 排行序号(从 1 开始) */ + id: number + /** 脱敏后商品名称(前 2 字符 + *** + 后 2 字符;长度不足 4 字符时为 ***) */ + name: string + /** 库存商品ID(stock_warehouse.id);极端情况下回退商品编码字符串 */ + sku: number | string + /** 今日销量(件数) */ + value: number + /** 环比昨日百分比(1 位小数;昨日为 0 且今日 >0 时为 100) */ + trend: number +} + +/** dashboard.order_trend 的 data(按小时统计当日 08:00 至当前小时) */ +export type DashboardOrderTrendData = { + /** 统计范围,固定为 day */ + range: string + /** 统计日期(YYYY-MM-DD) */ + date: string + summary: { + /** 当日订单总数 */ + total_orders: number + /** 当日发货总数 */ + total_shipments: number + /** 发货率(%,1 位小数) */ + shipment_rate: number + /** 订单峰值时段(如 08:00) */ + peak_hour: string + /** 峰值时段订单数 */ + peak_orders: number + } + /** 时段列表(08:00 至当前小时,如 ['08:00','09:00']) */ + categories: string[] + /** 各时段订单数(与 categories 一一对应) */ + orders: number[] + /** 各时段发货数(与 categories 一一对应) */ + shipments: number[] +} + +/** + * 获取仓库发货统计(**演示数据**:固定演示值,非实时查询;无业务入参) + */ +export function getWarehouseStats( + data: Record = {} +): Promise> { return getDashboardData('dashboard.warehouseStats', data) } /** - * 获取门店基础统计数据 + * 获取门店/仓库发货统计(真实查询;无业务入参,依据登录用户上下文区分仓库端与货主端) */ -export function getStoreStats(data: any = {}) { +export function getStoreStats( + data: Record = {} +): Promise> { return getDashboardData('dashboard.storeStats', data) } -export type OrderTrendData = Record +export type OrderTrendData = DashboardOrderTrendData -export type OrderTrendResponse = { - code?: number - message?: string - data?: OrderTrendData -} +export type OrderTrendResponse = DashboardEnvelope /** - * 获取订单趋势数据 + * 获取订单趋势数据(无业务入参,依据当前用户绑定仓库统计) */ export function getOrderTrend(data: Record = {}): Promise { return getDashboardData('dashboard.order_trend', data) } /** - * 获取平台分布数据 + * 获取平台分布数据(饼图;无业务入参,货主端跨已签约仓库汇总) */ -export function getPlatformDist(data: any = {}) { +export function getPlatformDist( + data: Record = {} +): Promise> { return getDashboardData('dashboard.platform_distribution', data) } /** - * 获取商品排行数据 + * 获取热销商品排行(今日销量 Top10;无业务入参) */ -export function getHotOrderRank(data: any = {}) { +export function getHotOrderRank( + data: Record = {} +): Promise> { return getDashboardData('dashboard.hot_order_rank', data) } /** - * 获取快递占比数据 + * 获取快递占比数据(饼图;无业务入参,货主端跨已签约仓库汇总) */ -export function getExpressRatio(data: any = {}) { +export function getExpressRatio( + data: Record = {} +): Promise> { return getDashboardData('dashboard.express_ratio', data) } diff --git a/src/api/frontconfig/frontConfig.ts b/src/api/frontconfig/frontConfig.ts index ed1931d2..a7f7b5b6 100644 --- a/src/api/frontconfig/frontConfig.ts +++ b/src/api/frontconfig/frontConfig.ts @@ -84,11 +84,19 @@ export type FrontConfigSaveInfoParams = { theme?: Record | string | null } -/** frontConfig.getDomain / setDomain 响应:域名与 DNS TXT 归属验证状态(9 字段) */ +/** + * frontConfig.getDomain / setDomain / checkDomain 响应:域名与 DNS TXT 归属验证状态(16 字段)。 + * 分两组:①生效域名组 9 字段(domain/domain_status/verify_host/verify_value/cname/verified_at/attempts/last_error); + * ②待验证域名组 7 字段(pending_*,两阶段域名切换新增)。 + * 两阶段语义:domain 始终是「生效域名」,切换期间(pending_active=true)仍为旧域名并继续对外服务, + * 只有 TXT 校验通过被提升后才换成新域名;pending_domain 是用户提交、等待 TXT 校验的待验证域名, + * 从未生效、不参与 frontConfig.getByDomain 放行。 + */ export type FrontConfigDomain = { warehouse_id?: number + /** 生效域名(未设置为空字符串;变更统一走 frontConfig.setDomain,由待验证组提升而来) */ domain?: string - /** 0 未验证 / 1 已验证 / 2 验证失败 */ + /** 生效域名验证状态:0 未验证 / 1 已验证 / 2 验证失败 */ domain_status?: number /** 待添加的 TXT 记录主机名(如 wmsv-xxxxxxxxxx.);domain_status=1 时返回空字符串 */ verify_host?: string @@ -102,10 +110,24 @@ export type FrontConfigDomain = { attempts?: number /** 最近一次校验失败原因(脱敏截断;未失败为空字符串) */ last_error?: string + /** 待验证域名(切换中非空;未发起切换为空字符串)。setDomain 只登记到本字段,校验通过后才提升为 domain */ + pending_domain?: string + /** 待验证域名的 TXT 记录主机名(pending_domain 非空时**始终回显**,用户据此配置 TXT 记录) */ + pending_verify_host?: string + /** 待验证域名的 TXT 记录值(32 位 hex;pending_domain 为空时返回空字符串) */ + pending_verify_value?: string + /** 待验证域名校验尝试次数 */ + pending_attempts?: number + /** 待验证域名最近一次校验失败原因(脱敏截断;未失败为空字符串) */ + pending_last_error?: string + /** 发起本次域名切换的时间(无待验证域名为 null) */ + pending_created_at?: string | null + /** 是否处于域名切换中(等价于 pending_domain 非空;true=待验证域名已登记、等待 TXT 校验) */ + pending_active?: boolean [key: string]: unknown } -/** frontConfig.checkDomain 响应:getDomain 的 9 字段 + 本次校验结果 */ +/** frontConfig.checkDomain 响应:getDomain 的 16 字段 + 本次校验结果 */ export type FrontConfigCheckDomainResult = FrontConfigDomain & { /** 本次校验是否通过 */ verified?: boolean @@ -176,17 +198,29 @@ export function frontConfigGetDomain(): Promise { return postFrontConfig('frontConfig.setDomain', data) } -/** 主动校验域名 DNS TXT 归属记录并回写库(成功→domain_status=1 并清理该域名公共缓存;失败→domain_status=2) */ +/** + * 主动校验域名 TXT 归属记录并回写库(两条路径,响应均同 getDomain 的 16 字段 + 本次校验结果): + * ①存在 pending_domain → 校验待验证域名,通过则提升为生效域名(清空 pending 组、旧域名进下线队列、 + * 清空证书并重置同步状态)并清理新旧两个公共缓存;不通过仅累加 pending_attempts 并写 pending_last_error。 + * ②无 pending_domain → 保持升级前口径:生效域名已验证则短路返回 verified=true(不写库); + * 未设置域名返回 400「请先设置域名」;历史未验证行沿用生效域名的 domain_verify_* 校验并回写。 + */ export function frontConfigCheckDomain(): Promise< FrontConfigCheckDomainResult & { code?: number; message?: string } > { diff --git a/src/api/index/index.ts b/src/api/index/index.ts index 9a67df68..bd75642f 100644 --- a/src/api/index/index.ts +++ b/src/api/index/index.ts @@ -460,4 +460,92 @@ export function toOrder(data: IndexToOrderParams): Promise data, isSystemApi: true } as any) +} + +// ============ index.uploadClientErrorLog ============ + +/** + * 客户端错误日志上报条目(字段命名兼容 snake_case 与 camelCase 别名)。 + * ⚠️ `error_message` 与 `error_stack` **至少一项有值**,否则该条被判为无效(计入 rejected)。 + */ +export type ClientErrorLogItem = { + /** 客户端类型:android/ios/web 等(表宽 32,超出截断);别名 clientType */ + client_type?: string + /** 客户端版本号(表宽 64,超出截断);别名 appVersion */ + app_version?: string + /** 设备唯一标识(表宽 128,超出截断);别名 deviceId */ + device_id?: string + /** 操作系统版本(表宽 64,超出截断);别名 osVersion */ + os_version?: string + /** 设备型号(表宽 128,超出截断);别名 deviceModel */ + device_model?: string + /** 错误类型/等级(表宽 64,超出截断);别名 errorType */ + error_type?: string + /** 错误信息(与 error_stack 至少一项有值;超出截断至 5000 字符);别名 errorMessage */ + error_message?: string + /** 错误堆栈(与 error_message 至少一项有值;超出截断至 65535 字符);别名 errorStack */ + error_stack?: string + /** 附加上下文(字符串或对象,对象序列化为 JSON 字符串;超出截断至 65535 字符) */ + extra?: string | Record + /** 上报幂等ID(唯一索引 uk_report_uuid;重复上报静默成功、不产生重复行;缺失时服务端生成 srv-{uuid},不保证幂等) */ + report_uuid?: string + /** 客户端错误发生时间(仅参考,不作为记录时间):毫秒/秒时间戳或日期字符串,非法值存 null */ + client_time?: string | number +} + +/** + * index.uploadClientErrorLog 入参:支持三种形态(三选一) + * - 单条对象:`{ client_type, error_message, ... }` + * - 数组:`[ { ... }, { ... } ]` + * - 包裹形态:`{ logs: [ { ... }, ... ] }` + * 单次最多 50 条(超出报 400)。 + */ +export type ClientErrorLogUploadParams = + | ClientErrorLogItem + | ClientErrorLogItem[] + | { logs: ClientErrorLogItem[] } + +/** index.uploadClientErrorLog 响应(方法级错误为 HTTP 200 + flag=failure,code=400/500) */ +export type ClientErrorLogUploadResponse = { + /** 结果标记:success */ + flag?: string + /** 业务码:200 成功;400 入参形状错误/空数据/超 50 条/全部条目无效;500 查询或写入失败 */ + code?: number + /** 提示文案(成功为「上报成功」) */ + message?: string + /** 服务处理结果标记(400/500 失败响应无此字段) */ + success?: boolean + /** 本次上报条数 */ + total?: number + /** 新入库条数 */ + accepted?: number + /** 幂等去重条数(report_uuid 已存在,静默成功、不产生重复行) */ + duplicated?: number + /** 校验失败条数 */ + rejected?: number + /** 拒绝明细(最多 10 条) */ + rejected_reasons?: { index: number; reason: string }[] + /** 服务端响应时间戳(秒) */ + timestamp?: number +} + +/** + * 上报客户端错误日志(免登录、免权限、免鉴权,保留系统日志):批量写入服务端暂存表 wms_client_error_log。 + * 入参支持单条对象 / 数组 / `{ logs: [...] }` 三种形态,单次最多 50 条。 + * `report_uuid` 幂等去重(重复上报静默成功);`client_time` 仅参考。 + */ +export function uploadClientErrorLog( + data: ClientErrorLogUploadParams +): Promise { + return request({ + url: '/system', + method: 'post', + params: { + method: 'index.uploadClientErrorLog', + v: '1.0', + timestamp: new Date().getTime() + }, + data, + isSystemApi: true + } as any) } \ No newline at end of file diff --git a/src/api/returnreceived/index.ts b/src/api/returnreceived/index.ts index 4f476a57..c809e76e 100644 --- a/src/api/returnreceived/index.ts +++ b/src/api/returnreceived/index.ts @@ -13,7 +13,9 @@ export type ReturnReceivedCreateParams = { } /** returnReceived.create:退回包裹扫码登记(30日内同仓库同单号幂等,以第一次为准) */ -export function returnReceivedCreate(data: ReturnReceivedCreateParams): Promise { +export function returnReceivedCreate( + data: ReturnReceivedCreateParams +): Promise { return request({ url: '/system', method: 'post', @@ -37,8 +39,14 @@ export type ReturnReceivedListWhere = { scan_date?: { operator: 'between' | 'gte' | 'lte'; value: [string, string] | string } /** 扫描人员工号ID(等值) */ scanner_id?: number + /** 扫描人员名称快照(等值) */ + scanner_name?: string /** 货主ID(等值) */ store_id?: number + /** 运单ID(等值,原单退回时回填) */ + order_express_id?: number + /** 订单ID(等值,原单退回时回填) */ + order_id?: number /** 是否原单退回:true=有关联原运单,false=无关联 */ is_original_return?: boolean /** 登记时间范围 { operator:'between'|'gte'|'lte', value:[start,end] 或单值 } */ @@ -51,7 +59,7 @@ export type ReturnReceivedListWhere = { export type ReturnReceivedListSort = { /** 排序字段:id / scan_date / created_at / updated_at / waybill_code */ sortField?: 'id' | 'scan_date' | 'created_at' | 'updated_at' | 'waybill_code' - /** 排序方向:asc / desc */ + /** 排序方向:asc / desc(默认 created_at desc) */ sortOrder?: 'asc' | 'desc' } @@ -62,8 +70,90 @@ export type ReturnReceivedListParams = { sort?: ReturnReceivedListSort } +/** 退回收到登记记录(list 行 / create.record / detail.record 共用字段) */ +export type ReturnReceivedRecord = { + id: number + warehouse_id?: number + /** 退回收件运单号(扫描到的退回包裹单号) */ + waybill_code: string + /** 扫描日期(YYYY-MM-DD) */ + scan_date?: string + scanner_id?: number + /** 扫描人员名称快照 */ + scanner_name?: string + /** 原运单ID(原单退回时回填,否则 null) */ + order_express_id?: number | null + /** 原订单ID(原单退回时回填,否则 null) */ + order_id?: number | null + /** 货主ID(原单退回时回填,否则 null) */ + store_id?: number | null + remark?: string | null + /** 是否已通知(0=未通知 1=已通知;由定时任务维护) */ + is_notified?: number + /** 是否原单退回(派生字段) */ + is_original_return?: boolean + /** 货主的合约货主备注名称(wms_store_warehouse.store_remask;非原单退回时为空字符串) */ + store_remark?: string + created_at?: string + updated_at?: string + [key: string]: unknown +} + +/** returnReceived.list 分页信息 */ +export type ReturnReceivedPagination = { + page: number + pageSize: number + total: number + totalPages?: number + hasPrevious?: boolean + hasNext?: boolean +} + +/** returnReceived.list 响应(/system 网关:业务字段与信封同级,无 data 包裹) */ +export type ReturnReceivedListResponse = { + flag?: string + /** 业务码:1 / 200 / 20000 均视为成功 */ + code?: number + message?: string + timestamp?: number + list?: ReturnReceivedRecord[] + pagination?: ReturnReceivedPagination + /** 兼容 data 包裹形态 */ + data?: { + list?: ReturnReceivedRecord[] + pagination?: ReturnReceivedPagination + } +} + +/** returnReceived.create 响应(平铺形态,兼容 data 包裹) */ +export type ReturnReceivedCreateResponse = { + flag?: string + code?: number + message?: string + timestamp?: number + /** 登记记录(含完整登记字段与派生 is_original_return/store_remark) */ + record?: ReturnReceivedRecord + /** 是否原单退回 */ + is_original_return?: boolean + /** 货主的合约货主备注名称(非原单退回时为空字符串) */ + store_remark?: string + /** 加急标记:退回查询记录表(wms_return_query_log)存在本仓库 + 本运单号记录时为 true,否则 false(查询失败降级 false) */ + is_urgent?: boolean + /** 是否命中 30 日幂等(true=返回第一次登记结果,未重复写入) */ + duplicated?: boolean + data?: { + record?: ReturnReceivedRecord + is_original_return?: boolean + store_remark?: string + is_urgent?: boolean + duplicated?: boolean + } +} + /** returnReceived.list:退回收到登记分页列表(仓库隔离,服务端注入 warehouse_id) */ -export function returnReceivedList(data: ReturnReceivedListParams = {}): Promise { +export function returnReceivedList( + data: ReturnReceivedListParams = {} +): Promise { return request({ url: '/system', method: 'post', @@ -127,9 +217,13 @@ export function returnReceivedDelete(data: ReturnReceivedDeleteParams): Promise< /** returnReceived.export 请求参数(where/sort 语义与 returnReceived.list 一致) */ export type ReturnReceivedExportParams = { - /** 查询条件,语义与 returnReceived.list 的 where 一致;禁止传 warehouse_id/warehouseId(服务端注入) */ + /** + * 查询条件,语义与 returnReceived.list 的 where 一致;禁止传 warehouse_id/warehouseId(服务端注入)。 + * 支持字段:waybill_code(模糊)、scan_date/created_at/updated_at(范围)、 + * scanner_id/scanner_name/store_id/order_express_id/order_id(等值)、is_original_return(是否原单退回) + */ where?: Record - /** 排序参数,语义与 returnReceived.list 的 sort 一致 */ + /** 排序参数,语义与 returnReceived.list 的 sort 一致(sortField 白名单 id/scan_date/created_at/updated_at/waybill_code,默认 created_at desc) */ sort?: { sortField?: string sortOrder?: string diff --git a/src/api/returnwaybill/index.ts b/src/api/returnwaybill/index.ts index f147f7e7..867f9b39 100644 --- a/src/api/returnwaybill/index.ts +++ b/src/api/returnwaybill/index.ts @@ -2,6 +2,90 @@ import request from '@/utils/request' const v = '1.0' +// ============ 记录与响应类型 ============ + +/** + * 运单退回登记记录(list 行 / create.record / detail.record 共用字段)。 + * ⚠️ `group_id/group_name/user_id/user_name` 为**登记来源**:仅站内信「查退回」触发登记时写入,后台登记为 null。 + * ⚠️ `is_notified/is_back` 由定时任务与拆包联动维护,登记接口不维护。 + */ +export type ReturnWaybillRecord = { + id: number + warehouse_id?: number + store_id?: number + /** 运单号 */ + waybill_code: string + /** 登记来源群ID(站内信触发登记时写入;后台登记为 null) */ + group_id?: number | null + /** 登记来源群名称(站内信触发登记时写入;后台登记为 null) */ + group_name?: string | null + /** 登记来源用户ID(站内信发送人;后台登记为 null) */ + user_id?: number | null + /** 登记来源用户名称(站内信发送人;后台登记为 null) */ + user_name?: string | null + remark?: string | null + /** 是否已通知(0=未通知 1=已通知;由定时任务维护) */ + is_notified?: number + /** 是否退回(0=未退回 1=已退回;由拆包单提交联动维护) */ + is_back?: number + created_at?: string + updated_at?: string + [key: string]: unknown +} + +/** returnWaybill.list 分页信息 */ +export type ReturnWaybillPagination = { + page: number + pageSize: number + total: number + totalPages?: number + hasPrevious?: boolean + hasNext?: boolean +} + +/** returnWaybill.list 响应(/system 网关:业务字段与信封同级;兼容 data 包裹) */ +export type ReturnWaybillListResponse = { + flag?: string + code?: number + message?: string + timestamp?: number + list?: ReturnWaybillRecord[] + pagination?: ReturnWaybillPagination + data?: { + list?: ReturnWaybillRecord[] + pagination?: ReturnWaybillPagination + } +} + +/** returnWaybill.create 响应(平铺形态,兼容 data 包裹) */ +export type ReturnWaybillCreateResponse = { + flag?: string + code?: number + message?: string + timestamp?: number + /** 登记记录(含登记来源字段;后台登记时来源均为 null) */ + record?: ReturnWaybillRecord + /** 是否命中已有记录(同仓库+货主+运单号已存在时为 true,返回已有记录、不重复插入) */ + duplicated?: boolean + data?: { + record?: ReturnWaybillRecord + duplicated?: boolean + } +} + +/** returnWaybill.detail 响应 */ +export type ReturnWaybillDetailResponse = { + flag?: string + code?: number + message?: string + timestamp?: number + /** 登记记录完整信息(含登记来源字段;后台登记为 null) */ + record?: ReturnWaybillRecord + data?: { + record?: ReturnWaybillRecord + } +} + // ============ returnWaybill.create ============ /** returnWaybill.create 请求参数 */ @@ -15,7 +99,9 @@ export type ReturnWaybillCreateParams = { } /** returnWaybill.create:运单退回登记(录入「货主 + 运单号」退回关系) */ -export function returnWaybillCreate(data: ReturnWaybillCreateParams): Promise { +export function returnWaybillCreate( + data: ReturnWaybillCreateParams +): Promise { return request({ url: '/system', method: 'post', @@ -78,7 +164,7 @@ export type ReturnWaybillListWhere = { export type ReturnWaybillListSort = { /** 排序字段 */ sortField?: 'id' | 'created_at' | 'updated_at' | 'waybill_code' - /** 排序方向:asc / desc */ + /** 排序方向:asc / desc(默认 created_at desc) */ sortOrder?: 'asc' | 'desc' } @@ -90,7 +176,9 @@ export type ReturnWaybillListParams = { } /** returnWaybill.list:运单退回登记分页列表(仓库隔离,服务端注入 warehouse_id) */ -export function returnWaybillList(data: ReturnWaybillListParams = {}): Promise { +export function returnWaybillList( + data: ReturnWaybillListParams = {} +): Promise { return request({ url: '/system', method: 'post', @@ -113,7 +201,9 @@ export type ReturnWaybillDetailParams = { } /** returnWaybill.detail:运单退回登记详情(仓库隔离校验) */ -export function returnWaybillDetail(data: ReturnWaybillDetailParams): Promise { +export function returnWaybillDetail( + data: ReturnWaybillDetailParams +): Promise { return request({ url: '/system', method: 'post', diff --git a/src/api/setting.warehouse/settingwarehouse.ts b/src/api/setting.warehouse/settingwarehouse.ts index 7e741618..7accf3fa 100644 --- a/src/api/setting.warehouse/settingwarehouse.ts +++ b/src/api/setting.warehouse/settingwarehouse.ts @@ -133,6 +133,11 @@ export type SettingWarehouseSubjectConfig = SettingWarehouseSenderConfig & { single_order_pack_max_minutes?: number /** 团购打包最大时长,单位:分钟,默认 40 */ group_order_pack_max_minutes?: number + /** + * 大团购波次(wave_scope=1)打包中,扫描其他波次订单至少需等待「当前波次打包数 × 系数」秒, + * 单位:秒/单,默认 3,**必须大于 0**(用于 workbench 大团购波次打包时长闸门与倒计时) + */ + big_group_pack_coefficient?: number /** 拆包最大录制时长,单位:分钟,默认 5,min 1;超过上限时拆包提交的结束时间自动截断为开始时间+上限 */ return_unpack_max_record_minutes?: number max_wave_quantity?: number @@ -407,6 +412,13 @@ export function normalizeWarehouseSubjectConfig( base.group_order_pack_max_minutes = Number.isFinite(groupPackMax) && groupPackMax > 0 ? Math.trunc(groupPackMax) : 40 + // 大团购打包系数(秒/单,默认 3,必须大于 0;允许小数,保留原值) + const bigGroupPackCoefficient = Number(base.big_group_pack_coefficient) + base.big_group_pack_coefficient = + Number.isFinite(bigGroupPackCoefficient) && bigGroupPackCoefficient > 0 + ? bigGroupPackCoefficient + : 3 + // 默认库位(库位ID,未配置时为 null) const locIdRaw = base.default_location_id if (locIdRaw === undefined || locIdRaw === null || locIdRaw === '') { diff --git a/src/api/waybill.warehouse/index.ts b/src/api/waybill.warehouse/index.ts index a3207a03..a9563a9e 100644 --- a/src/api/waybill.warehouse/index.ts +++ b/src/api/waybill.warehouse/index.ts @@ -66,7 +66,7 @@ export type WaybillWarehouseListParams = { sort?: WaybillWarehouseListSort } -/** 单次请求可覆盖的配置(不传则使用全局默认超时 10 秒) */ +/** 单次请求可覆盖的配置(不传则使用 list 类接口默认超时 5 分钟) */ export type WaybillRequestOptions = { /** 超时时间(毫秒) */ timeout?: number diff --git a/src/api/workbench/workbench.ts b/src/api/workbench/workbench.ts index 79b93848..0011f50a 100644 --- a/src/api/workbench/workbench.ts +++ b/src/api/workbench/workbench.ts @@ -171,6 +171,8 @@ export interface WorkbenchQueryOrderOrder { wave_id?: number /** 波次号 */ wave_no?: string + /** 波次范围:0=未分配波次 1=大团购 2=散单 3=小团购 4=单品单件(来自订单行 wave_scope) */ + wave_scope?: number /** 打单状态 */ post_status?: string /** 拣货状态 */ @@ -279,6 +281,42 @@ export interface WorkbenchBusinessResponse { code?: number } +/** + * workbench.packOrder 响应(`business({ name: 'packOrder', data })`)。 + * 推荐只传 token + key(key 来自 workbench.queryOrder 响应,20 分钟有效)。 + * ⚠️ 大团购波次(order.wave_scope=1)才附倒计时字段 pack_wait_seconds / pack_start_time,其他波次两字段均为 0。 + */ +export interface WorkbenchPackOrderResult { + /** 打包任务ID(wms_pack_task.id) */ + task_id: number + /** 订单ID */ + order_id: number + /** 发货单号 */ + delivery_order_code: string + /** 波次号 */ + wave_no: string + /** 是否散单:1=散单 0=团购(波次类型 wave_type=1 时判定为团购) */ + isSandan: number + /** 打包模式:1=散单 2=团购 */ + pack_mode: number + /** 任务状态:1=打包中 2=已完成 */ + status: number + /** 大团购倒计时等待秒数(大团购打包系数 × 当前波次打包数 ÷ 当前工作台打包人数;仅 wave_scope=1 有值,其他波次为 0) */ + pack_wait_seconds: number + /** 开始打包时间(毫秒时间戳;仅 wave_scope=1 有值,其他波次为 0) */ + pack_start_time: number + /** 团购波次信息(仅团购单 isSandan=0 时返回) */ + batch?: { + wave_id: number + wave_no: string + /** 波次类型(1=团购) */ + wave_type: number + /** 波次订单总数(current+dispatch 分表实时统计) */ + total_orders: number + } + code?: number +} + /** 工作台业务入口(免登录免鉴权,入参 name + data) */ export function business( data: WorkbenchBusinessParams diff --git a/src/utils/request.ts b/src/utils/request.ts index 5f9808d8..f3c6a560 100644 --- a/src/utils/request.ts +++ b/src/utils/request.ts @@ -6,18 +6,46 @@ import { import router from '@/router' import { useUserStore } from '@/stores/modules/user' +/** 全局默认超时时间(毫秒) */ +const DEFAULT_TIMEOUT_MS = 10000 + +/** 常规 list 类接口默认超时时间(毫秒):5 分钟 */ +const LIST_TIMEOUT_MS = 5 * 60 * 1000 + +/** + * 「常规 list 类接口」判定规则:网关接口名(params.method)以 list 结尾,不区分大小写。 + * 例如 waybill.warehouse.list / order.deliveryOrder.list / order.list / + * afterSale.workList / index.getExpressList / stock.warehouse.getProhibitedList 等。 + * 此类查询多涉及大表扫描或多表聚合,10 秒全局默认值容易超时。 + */ +const LIST_METHOD_PATTERN = /list$/i + // create an axios instance const service = axios.create({ baseURL: import.meta.env.VITE_APP_BASE_API, - timeout: 10000, // 建议适当延长超时时间 + timeout: DEFAULT_TIMEOUT_MS, // 全局默认 10 秒;常规 list 类接口在拦截器里放宽到 5 分钟 // withCredentials: true, // 根据实际情况决定是否开启 }); // 定义业务成功码 const SUCCESS_CODES = [200, 20000, 1,0] // 支持多种成功码 -/** 业务扩展请求配置:silentError=true 时拦截器不弹错误提示,由调用方自行兜底(如公共品牌按域名拉取) */ -type ServiceRequestConfig = { silentError?: boolean } +/** + * 业务扩展请求配置: + * - `silentError`:true 时拦截器不弹错误提示,由调用方自行兜底(如公共品牌按域名拉取) + * - `listTimeout`:单独控制 list 类接口超时。传毫秒数表示覆盖默认 5 分钟; + * 传 `false` 表示不套用 list 默认超时(保持全局默认 10 秒) + */ +type ServiceRequestConfig = { + silentError?: boolean + listTimeout?: number | false +} + +/** 取出网关接口名(`/system` 网关通过 `params.method` 指定,如 waybill.warehouse.list) */ +function getGatewayMethod(config: { params?: unknown }): string | undefined { + const params = config.params as { method?: unknown } | undefined + return typeof params?.method === 'string' ? params.method : undefined +} // 错误码映射 const ERROR_CODE_MAP = { @@ -59,6 +87,21 @@ service.interceptors.request.use( config => { config.headers['platform'] ='web'; config.headers['project'] ='all'; + + // 常规 list 类接口超时处理,优先级: + // listTimeout(数字) > 调用方显式 timeout > list 默认 5 分钟 > 全局默认 10 秒 + // 说明:仅当 timeout 仍为全局默认值时才套用 5 分钟,避免覆盖调用方单独放宽的超时 + //(如长轮询 70 秒、地址解析 10 分钟);若某 list 接口需要坚持 10 秒,传 listTimeout: false + const extraConfig = config as unknown as ServiceRequestConfig + if (typeof extraConfig.listTimeout === 'number') { + config.timeout = extraConfig.listTimeout + } else if (extraConfig.listTimeout !== false && config.timeout === DEFAULT_TIMEOUT_MS) { + const gatewayMethod = getGatewayMethod(config) + if (gatewayMethod && LIST_METHOD_PATTERN.test(gatewayMethod)) { + config.timeout = LIST_TIMEOUT_MS + } + } + // 添加 token const token = getToken() if (token) { diff --git a/src/views/express/returnReceived/index.vue b/src/views/express/returnReceived/index.vue index 55aac05c..4f606e58 100644 --- a/src/views/express/returnReceived/index.vue +++ b/src/views/express/returnReceived/index.vue @@ -75,6 +75,12 @@ @refresh="handleRefresh" @sort-change="handleSortChange" > + +