WMS_MAIN/database/migrations/20261118200000-add-goods-description-to-express-interface.js
liufumingren 2c615cb4f8 feat(expressInterface): 快递接口新增物品描述 goods_description 并用于菜鸟面单
- wms_express_interface 新增 goods_description VARCHAR(255) NULL(迁移 20261118200000)
- create/update 支持 goods_description(兼容 goodsDescription),最长 255 字符、允许为空
- list / listByWarehousePlatformCode 返回该字段
- 菜鸟电子面单 package_info.goods_description 改为读取接口配置,未配置时回退「化妆品」
- 同步 methods/system.json 与变更记录

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-11-18 19:28:39 +08:00

62 lines
2.2 KiB
JavaScript

'use strict';
/**
* wms_express_interface 增加 goods_description 列(物品描述)。
*
* 背景:菜鸟等电子面单接口的 package_info.goods_description 需要按快递接口配置下发,
* 原先在代码内硬编码为「化妆品」。现改为读取接口配置,未配置时仍回退到「化妆品」。
*
* 幂等:列存在性判断后再执行,重复运行安全。
*/
const TABLE_NAME = 'wms_express_interface';
const COLUMN_NAME = 'goods_description';
module.exports = {
/**
* 执行迁移:新增 goods_description 列。
* @param {import('sequelize').QueryInterface} queryInterface 查询接口。
* @param {Object} Sequelize Sequelize 类型集合。
* @return {Promise<void>} 无返回值。
*/
async up(queryInterface, Sequelize) {
const { STRING } = Sequelize;
const log = [];
const columns = await queryInterface.describeTable(TABLE_NAME);
if (!columns || Object.keys(columns).length === 0) {
throw new Error(`表 ${TABLE_NAME} 不存在,无法新增 ${COLUMN_NAME}`);
}
if (!Object.prototype.hasOwnProperty.call(columns, COLUMN_NAME)) {
await queryInterface.addColumn(TABLE_NAME, COLUMN_NAME, {
type: STRING(255),
allowNull: true,
comment: '物品描述',
});
log.push({ action: 'add-column', columnName: COLUMN_NAME });
} else {
log.push({ action: 'skip-add-column', columnName: COLUMN_NAME, reason: 'exists' });
}
console.log('[20261118200000-add-goods-description-to-express-interface] up results:', JSON.stringify(log));
},
/**
* 回滚迁移:移除 goods_description 列。
* @param {import('sequelize').QueryInterface} queryInterface 查询接口。
* @return {Promise<void>} 无返回值。
*/
async down(queryInterface) {
const log = [];
const columns = await queryInterface.describeTable(TABLE_NAME);
if (Object.prototype.hasOwnProperty.call(columns, COLUMN_NAME)) {
await queryInterface.removeColumn(TABLE_NAME, COLUMN_NAME);
log.push({ action: 'drop-column', columnName: COLUMN_NAME });
}
console.log('[20261118200000-add-goods-description-to-express-interface] down results:', JSON.stringify(log));
},
};