@newpeak/barista-cli 0.1.3 → 0.1.5

package/docs/commands/liberica/materials-enable.md

@@ -0,0 +1,146 @@
+# barista liberica materials enable
+
+启用（激活）物料。
+
+## 2.1 命令元数据
+
+| 字段 | 值 |
+|------|-----|
+| 完整命令 | `barista liberica materials enable <materialId>` |
+| 功能描述 | 启用（激活）物料 |
+| HTTP方法 | POST |
+| 是否需要认证 | ✅ 是 |
+| 是否支持dry-run | ✅ 是 |
+
+## 2.2 后端接口引用
+
+### Controller位置
+```
+coffee-liberica-end/
+└── facade/liberica-facade-enterprise/
+    └── src/main/java/com/newpeak/liberica/facade/enterprise/controller/master/
+        └── EnterpriseMaterialController.java
+            └── batchActive(@PostResource(path = "/batchActive", requiredPermission = true, requirePermissionCode = "ACTIVE_MASTER_MATERIAL"))
+                └── public ResponseData<?> batchActive(
+                        @RequestHeader("X-TENANT-ID") Long tenantId,
+                        @RequestBody @Validated(BaseRequest.batchDelete.class) MasterMaterialRequest masterMaterialRequest
+                    )
+```
+
+### Request DTO位置
+```
+coffee-liberica-end/
+└── business/liberica-business-sales/sales-api/
+    └── src/main/java/com/newpeak/liberica/sales/api/pojo/request/
+        └── MasterMaterialRequest.java
+            └── materialIdList: Set<Long> (用于批量操作)
+```
+
+### Response DTO位置
+```
+coffee-liberica-end/
+└── business/liberica-business-sales/sales-api/
+    └── src/main/java/com/newpeak/liberica/sales/api/pojo/response/
+        └── MasterMaterialResponse.java
+            └── 返回成功响应（无数据体）
+```
+
+## 2.3 CLI参数设计
+
+### 命令结构
+```
+barista liberica materials enable <materialId> [options]
+```
+
+### 位置参数
+| 参数 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| materialId | string | ✅ | 物料ID |
+
+### 全局选项
+| 选项 | 类型 | 说明 |
+|------|------|------|
+| `--env` | string | 目标环境(dev\|test\|prod-cn\|prod-jp) |
+| `--tenant` | string | 租户代码 |
+| `--dry-run` | boolean | 预览模式（不实际调用API） |
+| `--json` | boolean | JSON输出 |
+
+### 命令选项
+| 选项 | 短选项 | 类型 | 必填 | 默认值 | 说明 |
+|------|--------|------|------|--------|------|
+| --force | -f | boolean | ⬜ | false | 跳过确认提示 |
+
+**说明**：
+- `--dry-run` 预览启用操作的影响（显示将启用的物料信息）
+- `--force` 直接执行，不显示确认提示（适用于脚本自动化）
+
+## 2.4 字段映射表
+
+| CLI参数 | DTO字段 | 类型转换 | 验证规则 |
+|---------|---------|----------|----------|
+| <materialId> (位置参数) | materialIdList[0] | string→Long | @NotEmpty, 单元素数组 |
+
+**请求体构造**：
+```json
+{
+  "materialIdList": [12345]
+}
+```
+
+## 2.5 错误码引用
+
+### ExceptionEnum位置
+```
+coffee-liberica-end/
+└── business/liberica-business-sales/sales-api/
+    └── src/main/java/com/newpeak/liberica/sales/api/exception/enums/
+        └── MasterMaterialExceptionEnum.java
+            ├── MASTER_MATERIAL_NOT_EXIST("01001410001", "租户物料不存在")
+            ├── MASTER_MATERIAL_CODE_VALIDATE_NOT_EXIST_ERROR("01001410006", "指定{}不存在")
+            └── MASTER_MATERIAL_NAME_VALIDATE_NOT_EXIST_ERROR("01001410010", "指定{}不存在")
+```
+
+### 已知错误码
+| 错误码 | 错误消息 | 触发条件 |
+|--------|----------|----------|
+| 01001410001 | 租户物料不存在 | materialId 不存在或不属于当前租户 |
+| 01001410006 | 指定xxx不存在 | 指定关联的物料编码不存在 |
+| 01001410010 | 指定xxx不存在 | 指定关联的物料名称不存在 |
+
+## 2.6 权限检查
+
+| 检查项 | 位置 | 说明 |
+|--------|------|------|
+| PermissionConstants | `MasterMaterialPermissionConstants.ACTIVE_MASTER_MATERIAL` | Controller层 `@PostResource(requirePermissionCode = "ACTIVE_MASTER_MATERIAL")` |
+
+## 2.7 实现要点
+
+1. **批量API单条使用**：后端使用 `/batchActive` 批量接口，但 CLI 仅支持单条启用，将单个 ID 包装为单元素数组 `{ materialIdList: [id] }`
+2. **幂等性**：batchActive 操作是幂等的，对已启用的物料再次调用效果相同（直接设置 statusFlag=ENABLE）
+3. **Dry-run模式**：预览显示将启用的物料信息，但不实际发送请求
+4. **无强制选项**：--force 跳过确认提示，但不绕过后端权限检查
+5. **与disable对称**：enable 与 disable 互为逆操作，使用相同的 materialIdList 参数结构
+
+## 2.8 示例用法
+
+```bash
+# 启用物料（交互确认）
+barista liberica materials enable 12345
+
+# 跳过确认直接启用
+barista liberica materials enable 12345 --force
+
+# Dry-run 预览
+barista liberica materials enable 12345 --dry-run
+
+# JSON 输出
+barista liberica materials enable 12345 --force --json
+
+# 物料不存在
+barista liberica materials enable 99999
+# 输出: Error: 租户物料不存在 (01001410001)
+
+# 对已启用物料重复启用（幂等，无报错）
+barista liberica materials enable 12345 --force
+# 输出: ✓ 物料启用成功
+```

package/docs/commands/liberica/materials-get.md

@@ -0,0 +1,188 @@
+# barista liberica materials get
+
+获取单个物料详情。
+
+## 2.1 命令元数据
+
+| 字段 | 值 |
+|------|-----|
+| 完整命令 | `barista liberica materials get <id>` |
+| 功能描述 | 获取单个物料详情 |
+| HTTP方法 | GET |
+| 是否需要认证 | ✅ 是 |
+| 是否支持dry-run | ⬜ 否 |
+
+## 2.2 后端接口引用
+
+### Controller位置
+```
+coffee-liberica-end/
+└── facade/liberica-facade-enterprise/
+    └── src/main/java/com/newpeak/liberica/facade/enterprise/controller/master/
+        └── EnterpriseMaterialController.java
+            └── detail(@GetResource(path = "/detail"))
+                └── public ResponseData<MasterMaterialResponse> detail(
+                        @RequestHeader("X-TENANT-ID") Long tenantId,
+                        @ParameterObject @Validated(BaseRequest.detail.class) MasterMaterialRequest masterMaterialRequest
+                    )
+```
+
+### Request DTO位置
+```
+coffee-liberica-end/
+└── business/liberica-business-sales/sales-api/
+    └── src/main/java/com/newpeak/liberica/sales/api/pojo/request/
+        └── MasterMaterialRequest.java
+            └── materialId: Long (@NotNull on detail)
+```
+
+### Response DTO位置
+```
+coffee-liberica-end/
+└── business/liberica-business-sales/sales-api/
+    └── src/main/java/com/newpeak/liberica/sales/api/pojo/response/
+        └── MasterMaterialResponse.java
+            ├── materialId: Long
+            ├── materialCode: String
+            ├── materialNo: String
+            ├── materialName: String
+            ├── materialShortName: String
+            ├── materialMaker: String
+            ├── materialTags: Tags
+            ├── materialTagNames: List<String>
+            ├── materialClass: String
+            ├── mouldType: String
+            ├── materialBarCode: String
+            ├── materialType: String
+            ├── materialUomCode: String
+            ├── enableMultiUom: String (Y/N)
+            ├── multiUomCodes: MultiUom
+            ├── enableSale: String (Y/N)
+            ├── enablePurchase: String (Y/N)
+            ├── enableSubMaterial: String (Y/N)
+            ├── enableOutsourcing: String (Y/N)
+            ├── enableDivision: String (Y/N)
+            ├── enableShelfLifeManagement: String (Y/N)
+            ├── stopProduction: String (Y/N)
+            ├── shelfLifeUnit: String
+            ├── shelfLife: Integer
+            ├── shelfLifeWarningDays: Integer
+            ├── shippingMethod: String
+            ├── transactionMethod: String
+            ├── tradeType: String
+            ├── productionPeriod: Integer
+            ├── productionQuantityPerLot: BigDecimal
+            ├── lowLotRate: Float
+            ├── useMaterialLotRate: String (Y/N)
+            ├── substituteMaterials: SubstituteMaterials
+            ├── safetyInventory: BigDecimal
+            ├── defaultWarehouse: String
+            ├── defaultSupplier: String
+            ├── follower: String
+            ├── minPackageQuantity: String
+            ├── grossWeight: String
+            ├── netWeight: String
+            ├── color: String
+            ├── longX: BigDecimal
+            ├── longXUom: String
+            ├── wideY: BigDecimal
+            ├── wideYUom: String
+            ├── highZ: BigDecimal
+            ├── highZUom: String
+            ├── volume: String
+            ├── volumeUom: String
+            ├── thickness: BigDecimal
+            ├── thicknessUom: String
+            ├── totalThickness: BigDecimal
+            ├── diameter: BigDecimal
+            ├── diameterUom: String
+            ├── outerDiameter: BigDecimal
+            ├── outerDiameterUom: String
+            ├── innerDiameter: BigDecimal
+            ├── innerDiameterUom: String
+            ├── defaultClient: String
+            ├── unitPrice: BigDecimal
+            ├── currency: String
+            ├── statusFlag: Integer (1=enable, 2=disable)
+            ├── remark: String
+            ├── salesOrderCount: String
+            ├── salesOrderSummary: String
+            ├── createTime: String
+            └── updateTime: String
+```
+
+## 2.3 CLI参数设计
+
+### 命令结构
+```
+barista liberica materials get <id> [options]
+```
+
+### 位置参数
+| 参数 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| id | string | ✅ | 物料ID (materialId) |
+
+### 全局选项
+| 选项 | 类型 | 说明 |
+|------|------|------|
+| `--env` | string | 目标环境(dev\|test\|prod-cn\|prod-jp) |
+| `--tenant` | string | 租户代码 |
+| `--json` | boolean | JSON输出 |
+
+### 命令选项
+| 选项 | 短选项 | 类型 | 必填 | 默认值 | 说明 |
+|------|--------|------|------|--------|------|
+| — | — | — | — | — | 此命令无额外选项，ID 通过位置参数传入 |
+
+## 2.4 字段映射表
+
+| CLI参数 | DTO字段 | 类型转换 | 验证规则 |
+|---------|---------|----------|----------|
+| <id> (位置参数) | materialId | string→Long | @NotNull, 必须为正整数 |
+
+## 2.5 错误码引用
+
+### ExceptionEnum位置
+```
+coffee-liberica-end/
+└── business/liberica-business-sales/sales-api/
+    └── src/main/java/com/newpeak/liberica/sales/api/exception/enums/
+        └── MasterMaterialExceptionEnum.java
+            ├── MASTER_MATERIAL_NOT_EXIST("01001340001", "租户物料不存在")
+            ├── MASTER_MATERIAL_CODE_VALIDATE_NOT_EXIST_ERROR("01001340006", "指定{}不存在")
+            └── MASTER_MATERIAL_NAME_VALIDATE_NOT_EXIST_ERROR("01001340010", "指定{}不存在")
+```
+
+### 已知错误码
+| 错误码 | 错误消息 | 触发条件 |
+|--------|----------|----------|
+| 01001340001 | 租户物料不存在 | materialId 不存在或不属于当前租户 |
+
+## 2.6 权限检查
+
+| 检查项 | 位置 | 说明 |
+|--------|------|------|
+| 注解 | `@GetResource(path = "/detail")` | 无 requiredPermission |
+
+## 2.7 实现要点
+
+1. **位置参数**：`get` 命令使用 `<id>` 位置参数指定物料ID
+2. **错误处理**：物料不存在时抛出 `MASTER_MATERIAL_NOT_EXIST`，CLI 显示友好错误信息
+3. **tenantId来源**：来自 X-TENANT-ID header，后端自动按租户隔离数据
+4. **API端点**：GET `/api/enterprise/sales/material/detail?materialId={id}`
+5. **ID类型注意**：后端使用 Long (BigInteger) 类型，CLI 中使用 string 避免 JavaScript 精度丢失
+
+## 2.8 示例用法
+
+```bash
+# 获取物料详情
+barista liberica materials get 12345
+
+# JSON 输出
+barista liberica materials get 12345 --json
+
+# 物料不存在
+barista liberica materials get 99999
+# 输出: Error: 租户物料不存在 (01001340001)
+```

package/docs/commands/liberica/materials-list.md

@@ -0,0 +1,198 @@
+# barista liberica materials list
+
+分页查询物料列表。
+
+## 2.1 命令元数据
+
+| 字段 | 值 |
+|------|-----|
+| 完整命令 | `barista liberica materials list` |
+| 功能描述 | 分页查询物料列表 |
+| HTTP方法 | GET |
+| 是否需要认证 | ✅ 是 |
+| 是否支持dry-run | ⬜ 否 |
+
+## 2.2 后端接口引用
+
+### Controller位置
+```
+coffee-liberica-end/
+└── facade/liberica-facade-enterprise/
+    └── src/main/java/com/newpeak/liberica/facade/enterprise/controller/master/
+        └── EnterpriseMaterialController.java
+            └── page(@GetResource(path = "/page"))
+                └── public ResponseData<PageResult<MasterMaterialResponse>> page(
+                        @RequestHeader("X-TENANT-ID") Long tenantId,
+                        @ParameterObject MasterMaterialRequest masterMaterialRequest
+                    )
+```
+
+### Request DTO位置
+```
+coffee-liberica-end/
+└── business/liberica-business-sales/sales-api/
+    └── src/main/java/com/newpeak/liberica/sales/api/pojo/request/
+        └── MasterMaterialRequest.java
+            ├── pageNo: Long (分页页码，从0开始)
+            ├── pageSize: Long (分页大小)
+            ├── materialId: Long (物料ID)
+            ├── materialCode: String (物料编码)
+            ├── materialNo: String (物料号码)
+            ├── materialName: String (物料名称)
+            ├── materialClass: String (物料类别)
+            ├── statusFlag: Integer (状态：1=启用，2=禁用)
+            ├── queryMaterialTags: List<String> (物料标签查询条件)
+            ├── queryMaterialClass: List<String> (物料类别查询条件)
+            ├── queryMaterialCode: Set<String> (物料编码范围查询条件)
+            └── excludeMaterialCode: Set<String> (排除物料编码范围查询条件)
+```
+
+### Response DTO位置
+```
+coffee-liberica-end/
+└── business/liberica-business-sales/sales-api/
+    └── src/main/java/com/newpeak/liberica/sales/api/pojo/response/
+        └── MasterMaterialResponse.java
+            ├── materialId: Long
+            ├── materialCode: String
+            ├── materialNo: String
+            ├── materialName: String
+            ├── materialShortName: String
+            ├── materialMaker: String
+            ├── materialTags: Tags
+            ├── materialClass: String
+            ├── materialBarCode: String
+            ├── materialType: String
+            ├── materialUomCode: String
+            ├── enableMultiUom: String (Y/N)
+            ├── enableSale: String (Y/N)
+            ├── enablePurchase: String (Y/N)
+            ├── enableSubMaterial: String (Y/N)
+            ├── enableOutsourcing: String (Y/N)
+            ├── enableDivision: String (Y/N)
+            ├── enableShelfLifeManagement: String (Y/N)
+            ├── stopProduction: String (Y/N)
+            ├── safetyInventory: BigDecimal
+            ├── defaultWarehouse: String
+            ├── defaultSupplier: String
+            ├── follower: String
+            ├── unitPrice: BigDecimal
+            ├── currency: String
+            ├── statusFlag: Integer (1=启用，2=禁用)
+            ├── remark: String
+            ├── createTime: String
+            └── updateTime: String
+```
+
+### 分页包装器
+```
+cn.stylefeng.roses.kernel.db.api.pojo.page.PageResult
+    ├── totalRows: long
+    ├── pageSize: long
+    ├── pageNo: long
+    └── rows: List<MasterMaterialResponse>
+```
+
+## 2.3 CLI参数设计
+
+### 命令结构
+```
+barista liberica materials list [options]
+```
+
+### 全局选项
+| 选项 | 类型 | 说明 |
+|------|------|------|
+| `--env` | string | 目标环境(dev\|test\|prod-cn\|prod-jp) |
+| `--tenant` | string | 租户代码 |
+| `--json` | boolean | JSON输出 |
+
+### 命令选项
+| 选项 | 短选项 | 类型 | 必填 | 默认值 | 说明 | 对应DTO字段 |
+|------|--------|------|------|--------|------|-------------|
+| --page | -p | number | ⬜ | 1 | 页码（从1开始） | pageNo (转换：CLI页码-1) |
+| --size | -s | number | ⬜ | 20 | 每页条数 | pageSize |
+| --status | — | string | ⬜ | - | 状态：enable/disable | statusFlag (enable=1, disable=2) |
+| --class | -c | string | ⬜ | - | 物料类别 | queryMaterialClass |
+| --keyword | -k | string | ⬜ | - | 搜索关键词（物料编码/物料号码/物料名称） | materialCode/materialNo/materialName |
+
+## 2.4 字段映射表
+
+| CLI参数 | DTO字段 | 类型转换 | 验证规则 |
+|---------|---------|----------|----------|
+| --page / -p | pageNo | number→Long，CLI页码-1 | >= 1 |
+| --size / -s | pageSize | number→Long | 1-100 |
+| --status | statusFlag | string→Integer | enable=1, disable=2 |
+| --class / -c | queryMaterialClass | string→List<String> | - |
+| --keyword / -k | materialCode/materialNo/materialName | 直接传递 | 模糊查询 |
+
+## 2.5 错误码引用
+
+### ExceptionEnum位置
+```
+coffee-liberica-end/
+└── business/liberica-business-sales/sales-api/
+    └── src/main/java/com/newpeak/liberica/sales/api/exception/enums/
+        └── MasterMaterialExceptionEnum.java
+            ├── MASTER_MATERIAL_NOT_EXIST("01001411001", "租户物料不存在")
+            ├── MASTER_MATERIAL_CODE_FORMAT_CANNOT_EMPTY("01001411003", "物料编码规则不能为空")
+            ├── MASTER_MATERIAL_CODE_FORMAT_NOT_CORRECT("01001411004", "物料编码规则格式不正确")
+            ├── MASTER_MATERIAL_CODE_VALIDATE_EMPTY_ERROR("01001411005", "{}不能为空")
+            ├── MASTER_MATERIAL_CODE_VALIDATE_NOT_EXIST_ERROR("01001411006", "指定{}不存在")
+            ├── MASTER_MATERIAL_NO_VALIDATE_EMPTY_ERROR("01001411007", "{}不能为空")
+            ├── MASTER_MATERIAL_NO_VALIDATE_NOT_EXIST_ERROR("01001411008", "指定{}不存在")
+            ├── MASTER_MATERIAL_NAME_VALIDATE_EMPTY_ERROR("01001411009", "{}不能为空")
+            ├── MASTER_MATERIAL_NAME_VALIDATE_NOT_EXIST_ERROR("01001411010", "指定{}不存在")
+            └── MASTER_MATERIAL_NAME_DOES_NOT_MATCH_NO_ERROR("01001411011", "{}与{}不匹配")
+```
+
+### 已知错误码
+| 错误码 | 错误消息 | 触发条件 |
+|--------|----------|----------|
+| 01001411001 | 租户物料不存在 | 查询详情时ID不存在 |
+| 01001411006 | 指定物料编码不存在 | 物料编码无效 |
+| 01001411008 | 指定物料号码不存在 | 物料号码无效 |
+| 01001411010 | 指定物料名称不存在 | 物料名称无效 |
+
+## 2.6 权限检查
+
+| 检查项 | 位置 | 说明 |
+|--------|------|------|
+| 注解 | `@GetResource(path = "/page")` | 无 requiredPermission（无需权限码） |
+
+**注意**：page 接口在 Controller 层无需权限校验，数据范围通过 tenantId 隔离。
+
+## 2.7 实现要点
+
+1. **分页默认值**：page=1, size=20
+2. **分页转换**：CLI使用1-based页码，API使用0-based页码（调用时需减1）
+3. **搜索行为**：keyword 同时匹配 materialCode、materialNo 和 materialName（模糊查询）
+4. **状态映射**：CLI参数 `enable`/`disable` 映射到 API 值 `1`/`2`
+5. **无结果处理**：返回空列表，不抛出异常
+6. **tenantId来源**：来自 JWT token（无需 X-TENANT-ID header）
+7. **输出格式**：表格形式展示，分页信息在底部显示
+
+## 2.8 示例用法
+
+```bash
+# 默认分页
+barista liberica materials list
+
+# 指定页码和每页条数
+barista liberica materials list --page 2 --size 50
+
+# 按状态筛选
+barista liberica materials list --status enable
+
+# 按物料类别筛选
+barista liberica materials list --class "raw_material"
+
+# 关键词搜索
+barista liberica materials list --keyword "螺丝"
+
+# 组合筛选
+barista liberica materials list --page 1 --size 10 --status enable --keyword "M001"
+
+# JSON 输出（便于脚本处理）
+barista liberica materials list --page 1 --size 20 --json
+```