material.js 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. /**
  2. * 物料相关常量定义
  3. * @fileoverview 物料明细记录、查询参数等类型定义
  4. */
  5. // ==================== JSDoc 类型定义 ====================
  6. /**
  7. * 物料明细记录
  8. * @typedef {Object} MaterialDetailRecord
  9. * @property {string} id - 物料ID
  10. * @property {string} materialCode - 物料编码
  11. * @property {string} materialName - 物料名称
  12. * @property {string} specification - 规格
  13. * @property {string} unit - 单位
  14. * @property {number} quantity - 数量
  15. * @property {number} unitPrice - 单价
  16. * @property {number} totalPrice - 总价
  17. * @property {number} itemStatus - 明细状态:0未确认 1已确认 2部分发货 3已完成
  18. * @property {string} dataSource - 数据来源:REMOTE远程 IMPORTED导入
  19. * @property {boolean} isDeletable - 是否可删除
  20. * @property {string} [remark] - 备注
  21. * @property {string} [createTime] - 创建时间
  22. * @property {string} [updateTime] - 更新时间
  23. */
  24. /**
  25. * 订单表单模型
  26. * @typedef {Object} OrderFormModel
  27. * @property {string} id - 订单ID
  28. * @property {string} orderNo - 订单编号
  29. * @property {number} orderType - 订单类型:0未知 1普通
  30. * @property {number} orderStatus - 订单状态:0草稿 1待审核 2已审核 3已发货 4已完成 5已取消
  31. * @property {string} customerName - 客户名称
  32. * @property {string} customerContact - 客户联系方式
  33. * @property {string} deliveryAddress - 交货地址
  34. * @property {string} [deliveryDate] - 交货日期
  35. * @property {number} totalAmount - 订单总金额
  36. * @property {string} [remark] - 备注
  37. * @property {Array<MaterialDetailRecord>} materials - 物料明细列表
  38. * @property {string} [createTime] - 创建时间
  39. * @property {string} [updateTime] - 更新时间
  40. */
  41. /**
  42. * 物料查询参数
  43. * @typedef {Object} MaterialQueryParams
  44. * @property {string} [materialCode] - 物料编码
  45. * @property {string} [materialName] - 物料名称
  46. * @property {string} [specification] - 规格
  47. * @property {number} [itemStatus] - 明细状态
  48. * @property {string} [dataSource] - 数据来源
  49. * @property {number} [current] - 当前页码
  50. * @property {number} [pageSize] - 每页条数
  51. */
  52. /**
  53. * 物料删除事件数据
  54. * @typedef {Object} MaterialDeleteEventData
  55. * @property {string} id - 物料ID
  56. * @property {string} materialCode - 物料编码
  57. * @property {string} materialName - 物料名称
  58. * @property {number} itemStatus - 明细状态
  59. */
  60. export {}