import request from '@/utils/request' const v = '1.0' /* ===== 报表导出任务 ===== */ export interface ReportGenerateParams { /** 报表定义ID(与 reportId 二选一;均传时优先 reportId) */ report_id?: number /** 报表定义ID驼峰别名(兼容,优先级高于 report_id) */ reportId?: number /** 货主ID(可选,货主维度报表时传入;>0 生效,<=0 视为不按货主过滤) */ store_id?: number /** 货主ID驼峰别名(兼容,优先级高于 store_id) */ storeId?: number /** 查询器业务参数(透传) */ params?: { /** 数据日期(YYYY-MM-DD),用于导出文件名 file_name 模板的 {date} 占位 */ bizDate?: string /** 窗口数量覆盖(缺省 7,<=0 视为 7) */ dayCount?: number /** 切点小时覆盖(缺省 7,错制到 0-23) */ cutoverHour?: number } } export interface ReportTaskResponse { /** 导出任务ID(report_generate_ 前缀) */ task_id: string /** 任务状态:submitted/running/success/failed */ status: 'submitted' | 'running' | 'success' | 'failed' /** 任务进度百分比(0-100) */ progress: number /** 任务状态说明 */ message: string /** 任务结果对象;导出成功后为 { fileKey, url, filename, size } */ result: Record | null /** 失败时的错误信息;成功时为空字符串 */ error: string /** 任务状态更新时间(毫秒时间戳) */ update_time: number code?: number } /** 提交报表导出异步任务(手动导出):立即返回任务受理信息,后台异步执行 */ export function generate( data?: ReportGenerateParams ): Promise { return request({ url: '/system', method: 'post', params: { method: 'report.generate', v, timestamp: new Date().getTime() }, data: data ?? {}, isSystemApi: true } as any) } export interface ReportTaskProgressParams { /** 导出任务ID(下划线写法,与 taskId 二选一) */ task_id?: string /** 导出任务ID(驼峰写法,兼容别名) */ taskId?: string } export interface ReportTaskProgressResponse extends Omit { /** 任务状态:submitted/running/success/failed/not_found */ status: 'submitted' | 'running' | 'success' | 'failed' | 'not_found' /** 任务成功后返回的下载链接;未完成或失败时为空字符串 */ download_url: string } /** 查询报表导出任务进度与结果 */ export function generateTaskProgress( data: ReportTaskProgressParams ): Promise { return request({ url: '/system', method: 'post', params: { method: 'report.generateTaskProgress', v, timestamp: new Date().getTime() }, data, isSystemApi: true } as any) } /* ===== 货主报表投递计划 ===== */ export interface DeliveryPlanSaveParams { /** 货主ID(必填,正整数;<=0 报错) */ store_id: number /** 计划名称(可选,仅展示字段,不参与幂等/关联逻辑;未传不覆盖,null/空串/全空白归一化为 null 清空;非空 trim 后 ≤100 字符,超长报错) */ name?: string | null /** 报表定义ID(必填,正整数;须为已启用 is_enabled=1 的报表定义;与 reportId 二选一,均传优先 reportId) */ report_id: number /** 报表定义ID驼峰别名(兼容,优先级高于 report_id) */ reportId?: number /** 每日投递时间点数组(HH:mm 24 小时制,非空;自动去重并升序) */ schedule_times: string[] /** 投递渠道:仅支持 inbox,默认 inbox;wecom/link 已弃用 */ channel?: string /** 补投宽限分钟(0-1440),默认 60 */ late_grace_minutes?: number /** 备注(最长 500 字符) */ remark?: string /** 文本通知模板(≤500,标签 {time}/{url}/{report_name}/{biz_date}) */ notify_template?: string /** 通知群ID数组(wms_inbox_group.id,正整数去重 ≤20) */ notify_group_ids?: number[] /** 通知成员ID数组(外部 IM 用户 ID,去重 ≤100) */ notify_member_ids?: string[] } export interface DeliveryPlanItem { id: number store_id: number /** 货主名称(列表/详情展示) */ store_name?: string /** 计划名称 */ name: string /** 关联的报表定义ID(wms_report_definition.id) */ report_definition_id: number /** 关联报表名称(前端由 report_definition_id 关联填充) */ report_name?: string schedule_times: string[] channel: string /** 是否启用:0=停用 1=启用 */ enabled: number late_grace_minutes: number remark: string notify_template: string notify_group_ids: number[] | null notify_member_ids: string[] | null created_at: string updated_at: string } /** 新增/更新货主报表投递计划(货主 store_id + 报表定义 report_id 唯一,存在则更新) */ export function saveDeliveryPlan( data: DeliveryPlanSaveParams ): Promise { return request({ url: '/system', method: 'post', params: { method: 'report.deliveryPlan.save', v, timestamp: new Date().getTime() }, data, isSystemApi: true } as any) } export interface DeliveryPlanListParams { where?: { /** 货主ID(>0 时精确过滤) */ store_id?: number /** 报表定义ID(>0 时精确过滤) */ report_id?: number /** 启用状态:0=停用 1=启用;空值/未传不过滤 */ enabled?: number | string } pagination?: { /** 当前页码(默认 1) */ page?: number /** 每页条数(默认 20,上限 200) */ pageSize?: number } sort?: { /** 排序字段(白名单 id/created_at/updated_at/store_id/report_definition_id,默认 id) */ sortField?: string /** 排序方向(ASC/DESC,默认 DESC,大小写不敏感) */ sortOrder?: string } } export interface DeliveryPlanListResult { list: DeliveryPlanItem[] total: number page: number pageSize: number code?: number } /** 分页查询货主报表投递计划列表(管理侧) */ export function listDeliveryPlan( data?: DeliveryPlanListParams ): Promise { return request({ url: '/system', method: 'post', params: { method: 'report.deliveryPlan.list', v, timestamp: new Date().getTime() }, data: data ?? {}, isSystemApi: true } as any) } export interface DeliveryPlanCopyParams { /** 源投递计划ID(必填,正整数) */ id: number /** 目标货主ID数组(必填,正整数去重;复制到其他货主) */ store_ids: number[] } export interface DeliveryPlanCopyResult { /** 成功复制的计划列表(实际后端返回结构;每项含目标货主 store_id 与可选新计划 plan_id) */ created?: Array<{ store_id?: number; plan_id?: number }> /** 跳过的货主列表(含原因,如「货主不存在或状态异常」) */ skipped?: Array<{ store_id: number; reason?: string }> code?: number } /** 复制投递计划到其他货主(report.deliveryPlan.copy) */ export function copyDeliveryPlan( data: DeliveryPlanCopyParams ): Promise { return request({ url: '/system', method: 'post', params: { method: 'report.deliveryPlan.copy', v, timestamp: new Date().getTime() }, data, isSystemApi: true } as any) } /* ===== 货主报表投递记录 ===== */ export interface DeliveryLogListParams { where?: { /** 货主ID(>0 时精确过滤) */ store_id?: number /** 报表定义ID(>0 时精确过滤) */ report_id?: number /** 投递状态过滤(pending/exporting/delivered/failed/cancelled;非法值忽略) */ status?: string } pagination?: { page?: number pageSize?: number } sort?: { sortField?: string sortOrder?: string } } export interface DeliveryLogListItem { id: number /** 投递目标快照({group_ids, member_ids, notify_text},仅投递成功且配置文本通知时非 null) */ notify_targets?: { group_ids?: number[] | null member_ids?: string[] | null notify_text?: string } | null [key: string]: unknown } export interface DeliveryLogListResult { list: DeliveryLogListItem[] total: number page: number pageSize: number code?: number } /** 分页查询货主报表投递记录(审计) */ export function listDeliveryLog( data?: DeliveryLogListParams ): Promise { return request({ url: '/system', method: 'post', params: { method: 'report.deliveryLog.list', v, timestamp: new Date().getTime() }, data: data ?? {}, isSystemApi: true } as any) } /* ===== 报表元数据 ===== */ export interface ReportMetaParams { /** 报表定义ID(与 reportId 二选一;均传时优先 reportId) */ report_id?: number /** 报表定义ID驼峰别名(兼容,优先级高于 report_id) */ reportId?: number } export interface ReportMetaField { /** 字段键(与查询器返回行字段一一对应,如 item_code) */ key: string /** 字段中文名 */ label: string /** 字段类型:string/number/boolean/array */ type: string /** 是否预计算字段(非原始表字段),仅 true 时返回 */ computed?: boolean /** 是否按文本单元格渲染落地(长数字串防科学计数法),仅 true 时返回 */ asText?: boolean /** 该报表定义是否勾选此字段(true=已勾选) */ selected?: boolean /** 数组类型字段的子字段清单,仅数组类型字段返回 */ children?: ReportMetaField[] } export interface ReportMetaResponse { /** 报表定义ID(回显) */ report_id: number /** 报表名称 */ name: string /** 报表类型(注册 key,如 stockFlow) */ type: string /** 导出文件名模板(支持 {date} 占位) */ file_name: string /** 日窗口参数对象 */ window: { /** 窗口数量(默认 7) */ dayCount: number /** 切点小时 0-23(默认 7) */ cutoverHour: number } /** 注册类型全量字段清单(含 selected/asText 标记) */ fields: ReportMetaField[] code?: number } /** 查询报表前端可读的列元数据(只读静态字段清单 + 窗口参数,不执行真实数据查询) */ export function meta(data?: ReportMetaParams): Promise { return request({ url: '/system', method: 'post', params: { method: 'report.meta', v, timestamp: new Date().getTime() }, data: data ?? {}, isSystemApi: true } as any) } /* ===== 报表定义管理(report.definition.*) ===== */ /** 报表类型注册清单中的字段项(report.definition.typeList) */ export interface ReportDefinitionTypeField { /** 字段 key(与查询器返回行字段一一对应,如 item_code) */ key: string /** 字段中文名 */ label: string /** 字段类型:string/number/boolean/array */ type?: string /** 是否为格式化器预计算字段 */ computed?: boolean /** 是否为文本单元格(导出时按文本处理) */ asText?: boolean /** 数组类型字段的子字段清单(仅 type=array 时返回) */ children?: ReportDefinitionTypeField[] } /** 报表类型注册项(report.definition.typeList) */ export interface ReportDefinitionTypeItem { /** 类型 key(如 stockFlow) */ key: string /** 类型标题(如「库存变化以及补货报表」) */ title: string /** 口径描述 */ description: string /** 日窗口参数 */ window: { /** 窗口数量 */ dayCount: number /** 切点小时 0-23 */ cutoverHour: number } /** 全量字段清单 */ fields: ReportDefinitionTypeField[] } export interface ReportDefinitionTypeListResult { /** 注册类型清单(当前仅 stockFlow) */ list: ReportDefinitionTypeItem[] code?: number } /** 查询报表类型注册清单(只读公共元数据;免权限/免鉴权/免审计日志,仅要求登录) */ export function reportDefinitionTypeList(): Promise { return request({ url: '/system', method: 'post', params: { method: 'report.definition.typeList', v, timestamp: new Date().getTime() }, data: {}, isSystemApi: true } as any) } export interface ReportDefinitionSaveParams { /** 报表定义ID(正整数;不传视为新增;传入不存在报「报表定义不存在: id=」) */ id?: number /** 报表名称(必填,≤100 字符) */ name: string /** 报表类型(注册 key,如 stockFlow;新增必填,须命中注册表;更新时未传不覆盖既有值) */ type?: string /** 导出文件名模板(支持 {date} 占位;新增必填,≤200 字符;更新时未传不覆盖既有值) */ file_name?: string /** 导出文件名驼峰别名(兼容,优先级高于 file_name) */ fileName?: string /** 勾选字段 key 数组(新增必填,须为该类型注册字段子集;更新时未传不覆盖既有值) */ fields?: string[] /** 是否启用:0=停用 1=启用(仅入参存在时生效,未传不覆盖既有值) */ is_enabled?: number /** 备注(≤500 字符,超出截断) */ remark?: string } export interface ReportDefinitionItem { /** 报表定义ID */ id: number /** 报表名称 */ name: string /** 报表类型(注册 key,如 stockFlow) */ type: string /** 导出文件名模板(支持 {date} 占位) */ file_name: string /** 勾选字段 key 数组(保存后按传入顺序去重) */ fields: string[] /** 是否启用:0=停用 1=启用 */ is_enabled: number /** 备注 */ remark: string created_at: string updated_at: string code?: number } /** 新增/更新报表定义(report.definition.save,按 id upsert,未传字段不覆盖) */ export function saveReportDefinition( data: ReportDefinitionSaveParams ): Promise { return request({ url: '/system', method: 'post', params: { method: 'report.definition.save', v, timestamp: new Date().getTime() }, data, isSystemApi: true } as any) } export interface ReportDefinitionListParams { where?: { /** 报表名称模糊关键字(LIKE,通配符已转义) */ name?: string /** 报表类型精确筛选(注册 key,如 stockFlow;未命中注册表报「未知的报表类型」) */ type?: string /** 启用状态精确筛选:0=停用 1=启用;空值/未传不过滤 */ is_enabled?: number | string } pagination?: { page?: number pageSize?: number } sort?: { sortField?: string sortOrder?: string } } export interface ReportDefinitionListResult { list: ReportDefinitionItem[] total: number page: number pageSize: number code?: number } /** 分页查询报表定义列表(report.definition.list,软删自动排除) */ export function listReportDefinition( data?: ReportDefinitionListParams ): Promise { return request({ url: '/system', method: 'post', params: { method: 'report.definition.list', v, timestamp: new Date().getTime() }, data: data ?? {}, isSystemApi: true } as any) } export interface ReportDefinitionDeleteParams { /** 报表定义ID(必填,正整数;按 id 软删除,重复删除幂等成功) */ id: number } export interface ReportDefinitionDeleteResult { /** 已删除的报表定义ID */ id: number /** 删除结果标记(恒为 1) */ deleted: number code?: number } /** 软删除报表定义(report.definition.delete,删除前检查启用中的投递计划引用) */ export function deleteReportDefinition( data: ReportDefinitionDeleteParams ): Promise { return request({ url: '/system', method: 'post', params: { method: 'report.definition.delete', v, timestamp: new Date().getTime() }, data, isSystemApi: true } as any) }