@newpeak/barista-cli 0.1.4 → 0.1.6

package/docs/commands/liberica/currency/list.md

@@ -0,0 +1,149 @@
+# barista liberica currency list
+
+分页查询币种列表。
+
+## 2.1 命令元数据
+
+| 字段 | 值 |
+|------|-----|
+| 完整命令 | `barista liberica currency list` |
+| 功能描述 | 分页查询币种列表 |
+| HTTP方法 | GET |
+| 是否需要认证 | ✅ 是 |
+| 是否支持dry-run | ⬜ 否 |
+
+## 2.2 后端接口引用
+
+### Controller位置
+```
+coffee-liberica-end/
+└── facade/liberica-facade-enterprise/
+    └── src/main/java/com/newpeak/liberica/facade/enterprise/controller/finance/
+        └── FinanceCurrencyController.java
+            └── listCurrencies(@GetResource(path = "/page"))
+                └── public ResponseData<PageResult<CurrencyResponse>> listCurrencies(
+                        @ParameterObject CurrencyRequest request
+                    )
+```
+
+### Request DTO位置
+```
+coffee-liberica-end/
+└── business/liberica-business-finance/finance-api/src/main/java/com/newpeak/liberica/finance/api/pojo/request/CurrencyRequest.java
+    ├── pageNo: Long (分页页码，从0开始)
+    ├── pageSize: Long (分页大小)
+    ├── currencyCode: String (币种编码，如 CNY, USD)
+    ├── currencyName: String (币种名称)
+    └── statusFlag: Integer (状态：1=启用，2=禁用)
+```
+
+### Response DTO位置
+```
+coffee-liberica-end/
+└── business/liberica-business-finance/finance-api/src/main/java/com/newpeak/liberica/finance/api/pojo/response/CurrencyResponse.java
+    ├── currencyId: String
+    ├── currencyCode: String (3位编码，如 CNY)
+    ├── currencyName: String (币种名称)
+    ├── currencySign: String (符号，如 ¥)
+    ├── statusFlag: Integer (1=启用，2=禁用)
+    ├── createTime: String
+    └── updateTime: String
+```
+
+### 分页包装器
+```
+cn.stylefeng.roses.kernel.db.api.pojo.page.PageResult
+    ├── totalRows: long
+    ├── pageSize: long
+    ├── pageNo: long
+    └── rows: List<CurrencyResponse>
+```
+
+## 2.3 CLI参数设计
+
+### 命令结构
+```
+barista liberica currency 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) |
+| --code | -c | string | ⬜ | - | 币种编码（3位） | currencyCode |
+| --name | -n | string | ⬜ | - | 币种名称 | currencyName |
+
+## 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 |
+| --code / -c | currencyCode | string→String | 3位字母 |
+| --name / -n | currencyName | string→String | - |
+
+## 2.5 错误码引用
+
+### ExceptionEnum位置
+```
+coffee-liberica-end/
+└── business/liberica-business-finance/finance-api/src/main/java/com/newpeak/liberica/finance/api/exception/enums/CurrencyExceptionEnum.java
+```
+
+### 已知错误码
+| 错误码 | 错误消息 | 触发条件 |
+|--------|----------|----------|
+| CURRENCY_NOT_EXIST | 币种不存在 | 查询/编辑/删除时ID不存在 |
+| CURRENCY_CODE_DUPLICATE | 币种编码重复 | 创建/编辑时编码已存在 |
+
+## 2.6 权限检查
+
+| 检查项 | 位置 | 说明 |
+|--------|------|------|
+| 注解 | 无需权限 | 登录用户可访问 |
+
+## 2.7 实现要点
+
+1. **分页默认值**：page=1, size=20
+2. **分页转换**：CLI使用1-based页码，API使用0-based页码（调用时需减1）
+3. **编码格式**：currencyCode 为3位字母编码（ISO 4217标准，如 CNY, USD, EUR）
+4. **状态映射**：CLI参数 `enable`/`disable` 映射到 API 值 `1`/`2`
+5. **无结果处理**：返回空列表，不抛出异常
+6. **tenantId来源**：来自 JWT token（无需 X-TENANT-ID header）
+7. **输出格式**：表格形式展示，分页信息在底部显示
+8. **API路径**：GET `/api/enterprise/finance/currency/page`
+
+## 2.8 示例用法
+
+```bash
+# 默认分页
+barista liberica currency list
+
+# 指定页码和每页条数
+barista liberica currency list --page 2 --size 50
+
+# 按状态筛选
+barista liberica currency list --status enable
+
+# 按编码筛选
+barista liberica currency list --code "CNY"
+
+# 按名称搜索
+barista liberica currency list --name "人民币"
+
+# 组合筛选
+barista liberica currency list --page 1 --size 10 --status enable --code "CNY"
+
+# JSON 输出（便于脚本处理）
+barista liberica currency list --page 1 --size 20 --json
+```

package/docs/commands/liberica/currency/update.md

@@ -0,0 +1,141 @@
+# barista liberica currency update
+
+更新币种信息。
+
+## 2.1 命令元数据
+
+| 字段 | 值 |
+|------|-----|
+| 完整命令 | `barista liberica currency update <currency-id>` |
+| 功能描述 | 更新币种信息 |
+| HTTP方法 | POST |
+| 是否需要认证 | ✅ 是 |
+| 是否支持dry-run | ✅ 是 |
+
+## 2.2 后端接口引用
+
+### Controller位置
+```
+coffee-liberica-end/
+└── facade/liberica-facade-enterprise/
+    └── src/main/java/com/newpeak/liberica/facade/enterprise/controller/finance/
+        └── FinanceCurrencyController.java
+            └── editCurrency(@PostResource(path = "/edit"))
+                └── public ResponseData<CurrencyResponse> editCurrency(
+                        @RequestBody @Validated CurrencyRequest request
+                    )
+```
+
+### Request DTO位置
+```
+coffee-liberica-end/
+└── business/liberica-business-finance/finance-api/src/main/java/com/newpeak/liberica/finance/api/pojo/request/CurrencyRequest.java
+    ├── currencyId: String (@NotBlank)
+    ├── currencyCode: String (@NotBlank, 3位编码)
+    ├── currencyName: String (@NotBlank)
+    ├── currencySign: String (符号)
+    └── statusFlag: Integer (1=启用, 2=禁用)
+```
+
+### Response DTO位置
+```
+coffee-liberica-end/
+└── business/liberica-business-finance/finance-api/src/main/java/com/newpeak/liberica/finance/api/pojo/response/CurrencyResponse.java
+    ├── currencyId: String
+    ├── currencyCode: String
+    ├── currencyName: String
+    ├── currencySign: String
+    ├── statusFlag: Integer
+    ├── createTime: String
+    └── updateTime: String
+```
+
+## 2.3 CLI参数设计
+
+### 命令结构
+```
+barista liberica currency update <currency-id> [options]
+```
+
+### 全局选项
+| 选项 | 类型 | 说明 |
+|------|------|------|
+| `--env` | string | 目标环境(dev\|test\|prod-cn\|prod-jp) |
+| `--tenant` | string | 租户代码 |
+| `--dry-run` | boolean | 预览模式 |
+| `--json` | boolean | JSON输出 |
+
+### 位置参数
+| 参数 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| currency-id | string | ✅ | 币种ID |
+
+### 命令选项
+| 选项 | 短选项 | 类型 | 必填 | 默认值 | 说明 | 对应DTO字段 |
+|------|--------|------|------|--------|------|-------------|
+| --currency-id | -i | string | ⬜ | - | 币种ID（与位置参数互斥） | currencyId |
+| --code | -c | string | ✅ | - | 币种编码（3位） | currencyCode |
+| --name | -n | string | ✅ | - | 币种名称 | currencyName |
+| --sign | -S | string | ⬜ | - | 币种符号 | currencySign |
+
+## 2.4 字段映射表
+
+| CLI参数 | DTO字段 | 类型转换 | 验证规则 |
+|---------|---------|----------|----------|
+| currency-id (位置参数) | currencyId | string→String | @NotBlank |
+| --currency-id / -i | currencyId | string→String | @NotBlank |
+| --code / -c | currencyCode | string→String | @NotBlank, 3位字母 |
+| --name / -n | currencyName | string→String | @NotBlank, max=255 |
+| --sign / -S | currencySign | string→String | max=10 |
+
+## 2.5 错误码引用
+
+### ExceptionEnum位置
+```
+coffee-liberica-end/
+└── business/liberica-business-finance/finance-api/src/main/java/com/newpeak/liberica/finance/api/exception/enums/CurrencyExceptionEnum.java
+```
+
+### 已知错误码
+| 错误码 | 错误消息 | 触发条件 |
+|--------|----------|----------|
+| CURRENCY_NOT_EXIST | 币种不存在 | 币种不存在 |
+| CURRENCY_CODE_DUPLICATE | 币种编码重复 | 编码重复 |
+| CURRENCY_CODE_EMPTY | 币种编码不能为空 | 编码为空 |
+| CURRENCY_NAME_EMPTY | 币种名称不能为空 | 名称为空 |
+
+## 2.6 权限检查
+
+| 检查项 | 位置 | 说明 |
+|--------|------|------|
+| 注解 | FinanceCurrencyController.java | 需要 `finance_currency:edit` 权限 |
+
+## 2.7 实现要点
+
+1. **ID必填**：currencyId为必填参数（位置参数或 --currency-id 选项）
+2. **必填字段**：currencyCode 和 currencyName 为必填参数（通常需要先获取现有值再修改）
+3. **dry-run 支持**：支持 `--dry-run` 预览模式，显示将要更新的字段变化
+4. **完整更新**：后端可能是完整更新模式，需要提供所有字段值
+5. **建议用法**：先执行 `barista liberica currency get <id>` 获取当前值，再更新指定字段
+6. **API路径**：POST `/api/enterprise/finance/currency/edit`
+7. **成功响应**：返回更新后的币种详情
+
+## 2.8 示例用法
+
+```bash
+# 更新币种（通过位置参数）
+barista liberica currency update "1234567890123456789" --code "CNY" --name "人民币"
+
+# 更新币种（通过选项参数）
+barista liberica currency update --currency-id "1234567890123456789" --code "CNY" --name "人民币"
+barista liberica currency update -i "1234567890123456789" -c "CNY" -n "人民币"
+
+# 更新符号
+barista liberica currency update "1234567890123456789" --code "USD" --name "美元" --sign "$"
+
+# 预览模式（dry-run）
+barista liberica currency update "1234567890123456789" --code "EUR" --name "欧元" --dry-run
+
+# JSON 输出
+barista liberica currency update "1234567890123456789" --code "CNY" --name "人民币" --json
+```

package/docs/commands/liberica/materials/create.md

@@ -0,0 +1,293 @@
+# barista liberica materials create
+
+Create a new material (product).
+
+## 2.1 Command Metadata
+
+| Field | Value |
+|------|-----|
+| Full Command | `barista liberica materials create` |
+| Description | Create a new material |
+| HTTP Method | POST |
+| Requires Authentication | Yes |
+| Supports Dry-Run | Yes |
+
+## 2.2 Backend API Reference
+
+### Controller Location
+```
+coffee-liberica-end/
+└── facade/liberica-facade-enterprise/
+    └── src/main/java/com/newpeak/liberica/facade/enterprise/controller/master/
+        └── EnterpriseMaterialController.java
+            └── add(@PostResource(path = "/add", requiredPermission = true, requirePermissionCode = MasterMaterialPermissionConstants.ADD_MASTER_MATERIAL))
+                └── public ResponseData<MasterMaterialResponse> add(
+                        @RequestHeader("X-TENANT-ID") Long tenantId,
+                        @RequestBody @Validated(BaseRequest.add.class) MasterMaterialRequest request
+                    )
+```
+
+### Request DTO Location
+```
+coffee-liberica-end/
+└── business/liberica-business-sales/sales-api/
+    └── src/main/java/com/newpeak/liberica/sales/api/pojo/request/
+        └── MasterMaterialRequest.java
+            ├── materialCode: String (@NotBlank on add, max=255)
+            ├── materialNo: String (@NotBlank on add, max=255)
+            ├── materialName: String (@NotBlank on add, max=255)
+            ├── materialShortName: String (max=255)
+            ├── materialClass: String (@NotBlank on add, max=255)
+            ├── materialType: String (max=255)
+            ├── materialUomCode: String (max=255)
+            ├── enableSale: String (Y/N, max=1)
+            ├── enablePurchase: String (Y/N, max=1)
+            ├── enableSubMaterial: String (Y/N, max=1)
+            ├── enableOutsourcing: String (Y/N, max=1)
+            ├── enableDivision: String (Y/N, max=1)
+            ├── materialMaker: String (max=255)
+            ├── defaultWarehouse: String (max=255)
+            ├── defaultSupplier: String (max=255)
+            ├── unitPrice: BigDecimal
+            ├── currency: String (max=255)
+            └── remark: String (max=255)
+```
+
+### Response DTO Location
+```
+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
+            ├── materialClass: String
+            ├── materialType: String
+            ├── materialUomCode: String
+            ├── enableSale: String (Y/N)
+            ├── enablePurchase: String (Y/N)
+            ├── statusFlag: Integer (1=enable, 2=disable)
+            └── createTime: String
+```
+
+## 2.3 CLI Parameter Design
+
+### Command Structure
+```
+barista liberica materials create [options]
+```
+
+### Global Options
+| Option | Type | Description |
+|------|------|------|
+| `--env` | string | Target environment (dev\|test\|prod-cn\|prod-jp) |
+| `--tenant` | string | Tenant code |
+| `--dry-run` | boolean | Preview mode (no actual API call) |
+| `--json` | boolean | JSON output |
+
+### Command Options
+| Option | Short | Type | Required | Default | Description | Maps to DTO Field |
+|------|--------|------|------|--------|------|-------------|
+| --name | -n | string | Yes | - | Material name | materialName |
+| --class | -c | string | Yes | - | Material class/category | materialClass |
+| --type | -t | string | No | - | Specification/model | materialType |
+| --unit | -u | string | No | - | Unit of measure | materialUomCode |
+| --code | — | string | No | Auto-generated | Material code | materialCode |
+| --no | — | string | No | Same as code | Material number | materialNo |
+| --short-name | — | string | No | - | Short name | materialShortName |
+| --maker | — | string | No | - | Manufacturer | materialMaker |
+| --sale | — | boolean | No | true | Enable sale flag | enableSale |
+| --purchase | — | boolean | No | true | Enable purchase flag | enablePurchase |
+| --sub-material | — | boolean | No | false | Can be sub-material | enableSubMaterial |
+| --outsourcing | — | boolean | No | false | Enable outsourcing | enableOutsourcing |
+| --division | — | boolean | No | false | Enable cutting/division | enableDivision |
+| --warehouse | -w | string | No | - | Default warehouse | defaultWarehouse |
+| --supplier | -s | string | No | - | Default supplier | defaultSupplier |
+| --price | -p | number | No | - | Unit price | unitPrice |
+| --currency | — | string | No | - | Currency code | currency |
+| --remark | -r | string | No | - | Remarks | remark |
+
+## 2.4 Field Mapping Table
+
+| CLI Parameter | DTO Field | Type Conversion | Validation Rule |
+|---------|---------|----------|----------|
+| --name / -n | materialName | Direct | @NotBlank, max=255 |
+| --class / -c | materialClass | Direct | @NotBlank, max=255 |
+| --type / -t | materialType | Direct | max=255 |
+| --unit / -u | materialUomCode | Direct | max=255 |
+| --code | materialCode | Direct | max=255, auto-generated if empty |
+| --no | materialNo | Direct | max=255, defaults to code |
+| --short-name | materialShortName | Direct | max=255 |
+| --maker | materialMaker | Direct | max=255 |
+| --sale | enableSale | boolean->String (Y/N) | max=1 |
+| --purchase | enablePurchase | boolean->String (Y/N) | max=1 |
+| --sub-material | enableSubMaterial | boolean->String (Y/N) | max=1 |
+| --outsourcing | enableOutsourcing | boolean->String (Y/N) | max=1 |
+| --division | enableDivision | boolean->String (Y/N) | max=1 |
+| --warehouse / -w | defaultWarehouse | Direct | max=255 |
+| --supplier / -s | defaultSupplier | Direct | max=255 |
+| --price / -p | unitPrice | number->BigDecimal | - |
+| --currency | currency | Direct | max=255 |
+| --remark / -r | remark | Direct | max=255 |
+
+**Auto-Generated Fields:**
+| Field | Value |
+|------|-----|
+| tenantId | From JWT token (do NOT pass X-TENANT-ID header) |
+| statusFlag | Default 1 (enabled) |
+| materialCode | Auto-generated via getCodeByType('TenantMaterialCode') if not provided |
+| materialNo | Defaults to materialCode if not provided |
+
+## 2.5 Auto Code Generation Flow
+
+When `--code` is not provided, the CLI automatically generates a material code:
+
+```typescript
+// Call getCodeByType API to generate code
+const codeResponse = await apiClient.getCodeByType(
+  environment, 
+  tenant, 
+  'TenantMaterialCode'  // Code type from TenantCodeType enum
+);
+
+if (codeResponse.success && codeResponse.data) {
+  materialCode = codeResponse.data;
+} else {
+  throw new Error('Failed to generate material code');
+}
+```
+
+**API Details:**
+- Endpoint: `GET /api/enterprise/master/id/getCodeByType?type=TenantMaterialCode`
+- Response: `{ success: true, data: "MAT-2024-0001" }`
+- Code Type: `TenantMaterialCode` (defined in `TenantCodeType.java`)
+
+**Backend Code Generation:**
+```
+coffee-liberica-end/
+└── business/liberica-business-master/master-api/
+    └── src/main/java/com/newpeak/liberica/master/api/enums/
+        └── TenantCodeType.java
+            └── TenantMaterialCode  // Line 66
+```
+
+## 2.6 Error Code Reference
+
+### ExceptionEnum Location
+```
+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("01001200001", "租户物料不存在")
+            ├── MASTER_MATERIAL_CODE_FORMAT_CANNOT_EMPTY("01001200003", "物料编码规则不能为空")
+            ├── MASTER_MATERIAL_CODE_FORMAT_NOT_CORRECT("01001200004", "物料编码规则格式不正确")
+            ├── MASTER_MATERIAL_CODE_VALIDATE_EMPTY_ERROR("01001200005", "{}不能为空")
+            ├── MASTER_MATERIAL_CODE_VALIDATE_NOT_EXIST_ERROR("01001200006", "指定{}不存在")
+            ├── MASTER_MATERIAL_NO_VALIDATE_EMPTY_ERROR("01001200007", "{}不能为空")
+            ├── MASTER_MATERIAL_NAME_VALIDATE_EMPTY_ERROR("01001200009", "{}不能为空")
+            ├── ENABLE_DIVISION_MATERIAL_NEED_WIDE_AND_LONG("01001200012", "可分割物料必须设置长和宽")
+            └── ENABLE_DIVISION_MATERIAL_NEED_WIDE_AND_LONG_GT_ZERO("01001200013", "可分割物料长和宽必须大于0")
+```
+
+### Known Error Codes
+| Error Code | Error Message | Trigger Condition |
+|--------|----------|----------|
+| 01001200001 | Material does not exist | Query/edit with non-existent ID |
+| 01001200003 | Material code format cannot be empty | Auto-generation rule not configured |
+| 01001200004 | Material code format incorrect | Invalid code format pattern |
+| 01001200005 | {} cannot be empty | Required field missing (materialCode) |
+| 01001200007 | {} cannot be empty | Required field missing (materialNo) |
+| 01001200009 | {} cannot be empty | Required field missing (materialName) |
+| 01001200012 | Divisible material must set length and width | enableDivision=true without dimensions |
+| 01001200013 | Divisible material length and width must be > 0 | enableDivision with invalid dimensions |
+
+## 2.7 Permission Check
+
+| Check Item | Location | Description |
+|--------|------|------|
+| PermissionConstants | `MasterMaterialPermissionConstants.ADD_MASTER_MATERIAL` | Controller layer `@PostResource(requirePermissionCode = "ADD_MASTER_MATERIAL")` |
+
+## 2.8 Implementation Notes
+
+1. **Required Fields**: `--name` and `--class` must be provided
+2. **Auto-Generated Code**: `materialCode` is auto-generated via `getCodeByType('TenantMaterialCode')` if not provided
+3. **Material Number**: `materialNo` defaults to `materialCode` if not explicitly provided
+4. **Dry-Run Support**: Use `--dry-run` to preview request without calling API
+5. **Boolean Flags**: All enable flags (sale, purchase, etc.) default to sensible values
+6. **No Batch Create**: This command does NOT support batch creation (one material per call)
+7. **No Interactive Wizard**: No interactive prompts for optional fields (use explicit options)
+
+## 2.9 Example Usage
+
+```bash
+# Create with minimal required fields (auto-generates code)
+barista liberica materials create --name "Steel Plate" --class "RAW_MATERIAL"
+
+# Create with all common options
+barista liberica materials create \
+  --name "Aluminum Sheet 5052" \
+  --class "RAW_MATERIAL" \
+  --type "5052-H32" \
+  --unit "PCS" \
+  --sale \
+  --purchase \
+  --warehouse "MAIN_WH" \
+  --price 125.50 \
+  --currency "USD" \
+  --remark "Standard aluminum sheet"
+
+# Create with explicit code (skip auto-generation)
+barista liberica materials create \
+  --code "MAT-001" \
+  --name "Custom Part" \
+  --class "FINISHED_GOOD"
+
+# Dry-run to preview
+barista liberica materials create \
+  --name "Test Material" \
+  --class "TEST" \
+  --dry-run
+
+# JSON output
+barista liberica materials create \
+  --name "New Product" \
+  --class "PRODUCT" \
+  --json
+```
+
+## 2.10 Request Body Structure
+
+```json
+{
+  "materialCode": "MAT-2024-0001",
+  "materialNo": "MAT-2024-0001",
+  "materialName": "Steel Plate",
+  "materialClass": "RAW_MATERIAL",
+  "materialType": "SPCC",
+  "materialUomCode": "PCS",
+  "enableSale": "Y",
+  "enablePurchase": "Y",
+  "enableSubMaterial": "N",
+  "enableOutsourcing": "N",
+  "enableDivision": "N",
+  "statusFlag": 1
+}
+```
+
+## 2.11 API Path
+
+```
+POST /api/enterprise/sales/material/add
+```
+
+**Headers:**
+```
+Authorization: <token>  (No "Bearer " prefix)
+Content-Type: application/json
+```
+
+**Note**: Do NOT include `X-TENANT-ID` header. Tenant is extracted from JWT token.