@newpeak/barista-cli 0.1.6 → 0.1.7

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

@@ -0,0 +1,195 @@
+# barista liberica locations create
+
+Create a new warehouse location.
+
+## 2.1 Command Metadata
+
+| Field | Value |
+|------|-----|
+| Full Command | `barista liberica locations create` |
+| Description | Create a new warehouse location |
+| 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/stock/
+        └── EnterpriseWarehouseLocationController.java
+            └── add(@PostResource(path = "/add", requiredPermission = true, requirePermissionCode = MasterWarehouseLocationPermissionConstants.ADD_MASTER_WAREHOUSE_LOCATION))
+                └── public ResponseData<MasterWarehouseLocationResponse> add(
+                        @RequestHeader("X-TENANT-ID") Long tenantId,
+                        @RequestBody @Validated(BaseRequest.add.class) MasterWarehouseLocationRequest masterWarehouseLocationRequest
+                    )
+```
+
+### Request DTO Location
+```
+coffee-liberica-end/
+└── business/liberica-business-master/master-api/
+    └── src/main/java/com/newpeak/liberica/master/api/pojo/request/
+        └── MasterWarehouseLocationRequest.java
+            ├── warehouseId: Long (@NotNull on add)
+            ├── warehouseLocationCode: String (@NotBlank on add, max=255)
+            ├── warehouseLocationName: String (max=255)
+            ├── statusFlag: Integer
+            └── remark: String (max=255)
+```
+
+### Response DTO Location
+```
+coffee-liberica-end/
+└── business/liberica-business-master/master-api/
+    └── src/main/java/com/newpeak/liberica/master/api/pojo/response/
+        └── MasterWarehouseLocationResponse.java
+            ├── warehouseLocationId: Long
+            ├── warehouseId: Long
+            ├── warehouseLocationCode: String
+            ├── warehouseLocationName: String
+            ├── statusFlag: Integer (1=enable, 2=disable)
+            └── remark: String
+```
+
+## 2.3 CLI Parameter Design
+
+### Command Structure
+```
+barista liberica locations 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 |
+|------|--------|------|------|--------|------|-------------|
+| --warehouse-id | -w | string | Yes | - | Parent warehouse ID | warehouseId |
+| --code | -c | string | Yes | - | Location code | warehouseLocationCode |
+| --name | -n | string | Yes | - | Location name | warehouseLocationName |
+| --status | -s | number | No | 1 | Status (1=enable, 2=disable) | statusFlag |
+| --remark | -r | string | No | - | Remarks | remark |
+
+## 2.4 Field Mapping Table
+
+| CLI Parameter | DTO Field | Type Conversion | Validation Rule |
+|---------|---------|----------|----------|
+| --warehouse-id / -w | warehouseId | string | @NotNull, max=255 |
+| --code / -c | warehouseLocationCode | Direct | @NotBlank, max=255, unique per warehouse |
+| --name / -n | warehouseLocationName | Direct | max=255 |
+| --status / -s | statusFlag | number | 1 or 2 |
+| --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) when not provided |
+
+## 2.5 Error Code Reference
+
+### ExceptionEnum Location
+```
+coffee-liberica-end/
+└── business/liberica-business-master/master-api/
+    └── src/main/java/com/newpeak/liberica/master/api/exception/enums/
+        └── MasterWarehouseLocationExceptionEnum.java
+            ├── MASTER_WAREHOUSE_LOCATION_NOT_EXIST("01001380001", "租户仓位不存在")
+            ├── MASTER_WAREHOUSE_LOCATION_CODE_FORMAT_CANNOT_EMPTY("01001380002", "仓位编码规则不能为空")
+            └── MASTER_WAREHOUSE_LOCATION_CODE_FORMAT_NOT_CORRECT("01001380003", "仓位编码规则格式不正确")
+```
+
+### Known Error Codes
+| Error Code | Error Message | Trigger Condition |
+|--------|----------|----------|
+| 01001380001 | Location does not exist | Edit/detail with non-existent ID |
+| 01001380002 | Location code format cannot be empty | Auto-generation rule not configured |
+| 01001380003 | Location code format incorrect | Invalid code format pattern |
+
+## 2.6 Permission Check
+
+| Check Item | Location | Description |
+|--------|------|------|
+| PermissionConstants | `MasterWarehouseLocationPermissionConstants.ADD_MASTER_WAREHOUSE_LOCATION` | Controller layer `@PostResource(requirePermissionCode = "ADD_MASTER_WAREHOUSE_LOCATION")` |
+
+## 2.7 Implementation Notes
+
+1. **Required Fields**: `--warehouse-id`, `--code`, and `--name` must be provided.
+2. **Manual Code**: `warehouseLocationCode` is NOT auto-generated. Must be unique within the warehouse.
+3. **Dry-Run Support**: Use `--dry-run` to preview request without calling API.
+4. **Status Default**: `--status` defaults to 1 (enabled).
+5. **No Batch Create**: This command does NOT support batch creation (one location per call). Use `barista liberica locations batch-create` for bulk operations if implemented separately.
+6. **BigInteger IDs**: `warehouseLocationId` and `warehouseId` in response must be parsed as `string` in TypeScript to avoid precision loss.
+
+## 2.8 Example Usage
+
+```bash
+# Create with minimal required fields
+barista liberica locations create \
+  --warehouse-id "1234567890123456789" \
+  --code "A-01-01" \
+  --name "Shelf A-01-01"
+
+# Create with all options
+barista liberica locations create \
+  --warehouse-id "1234567890123456789" \
+  --code "B-02-03" \
+  --name "Bin B-02-03" \
+  --status 1 \
+  --remark "High-priority picking zone"
+
+# Create disabled location
+barista liberica locations create \
+  --warehouse-id "1234567890123456789" \
+  --code "C-99-99" \
+  --name "Reserved" \
+  --status 2
+
+# Dry-run to preview
+barista liberica locations create \
+  --warehouse-id "1234567890123456789" \
+  --code "TEST-01" \
+  --name "Test Location" \
+  --dry-run
+
+# JSON output
+barista liberica locations create \
+  --warehouse-id "1234567890123456789" \
+  --code "D-04-01" \
+  --name "Dock D-04-01" \
+  --json
+```
+
+## 2.9 Request Body Structure
+
+```json
+{
+  "warehouseId": "1234567890123456789",
+  "warehouseLocationCode": "A-01-01",
+  "warehouseLocationName": "Shelf A-01-01",
+  "statusFlag": 1,
+  "remark": "High-priority picking zone"
+}
+```
+
+## 2.10 API Path
+
+```
+POST /api/enterprise/purchases/warehouse/location/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.

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

@@ -0,0 +1,171 @@
+# barista liberica locations list
+
+List warehouse locations with pagination.
+
+## 2.1 Command Metadata
+
+| Field | Value |
+|------|-----|
+| Full Command | `barista liberica locations list` |
+| Description | List warehouse locations with pagination |
+| HTTP Method | GET |
+| Requires Authentication | Yes |
+| Supports Dry-Run | No |
+
+## 2.2 Backend API Reference
+
+### Controller Location
+```
+coffee-liberica-end/
+└── facade/liberica-facade-enterprise/
+    └── src/main/java/com/newpeak/liberica/facade/enterprise/controller/stock/
+        └── EnterpriseWarehouseLocationController.java
+            └── page(@GetResource(path = "/page"))
+                └── public ResponseData<PageResult<MasterWarehouseLocationResponse>> page(
+                        @RequestHeader("X-TENANT-ID") Long tenantId,
+                        @ParameterObject MasterWarehouseLocationRequest masterWarehouseLocationRequest
+                    )
+```
+
+### Request DTO Location
+```
+coffee-liberica-end/
+└── business/liberica-business-master/master-api/
+    └── src/main/java/com/newpeak/liberica/master/api/pojo/request/
+        └── MasterWarehouseLocationRequest.java
+            ├── warehouseId: Long
+            ├── warehouseLocationCode: String
+            ├── warehouseLocationName: String
+            ├── statusFlag: Integer
+            └── remark: String
+```
+
+### Response DTO Location
+```
+coffee-liberica-end/
+└── business/liberica-business-master/master-api/
+    └── src/main/java/com/newpeak/liberica/master/api/pojo/response/
+        └── MasterWarehouseLocationResponse.java
+            ├── warehouseLocationId: Long
+            ├── warehouseId: Long
+            ├── warehouseLocationCode: String
+            ├── warehouseLocationName: String
+            ├── statusFlag: Integer (1=enable, 2=disable)
+            └── remark: String
+```
+
+## 2.3 CLI Parameter Design
+
+### Command Structure
+```
+barista liberica locations list [options]
+```
+
+### Global Options
+| Option | Type | Description |
+|------|------|------|
+| `--env` | string | Target environment (dev\|test\|prod-cn\|prod-jp) |
+| `--tenant` | string | Tenant code |
+| `--json` | boolean | JSON output |
+
+### Command Options
+| Option | Short | Type | Required | Default | Description | Maps to Query Param |
+|------|--------|------|------|--------|------|-------------|
+| --page | -p | number | No | 1 | Page number (CLI 1-based) | pageNo (0-based) |
+| --size | -s | number | No | 20 | Page size | pageSize |
+| --warehouse-id | -w | string | No | - | Filter by parent warehouse ID | warehouseId |
+| --status | — | number | No | - | Status filter (1=enable, 2=disable) | statusFlag |
+| --keyword | -k | string | No | - | Keyword search (warehouseLocationName and warehouseLocationCode) | warehouseLocationName / warehouseLocationCode |
+
+## 2.4 Field Mapping Table
+
+| CLI Parameter | Query Param / DTO Field | Type Conversion | Validation Rule |
+|---------|---------|----------|----------|
+| --page / -p | pageNo | number, CLI page - 1 | >= 0 |
+| --size / -s | pageSize | number | > 0 |
+| --warehouse-id / -w | warehouseId | string | - |
+| --status | statusFlag | number | 1 or 2 |
+| --keyword / -k | warehouseLocationName / warehouseLocationCode | Direct | max=255 |
+
+## 2.5 Error Code Reference
+
+### ExceptionEnum Location
+```
+coffee-liberica-end/
+└── business/liberica-business-master/master-api/
+    └── src/main/java/com/newpeak/liberica/master/api/exception/enums/
+        └── MasterWarehouseLocationExceptionEnum.java
+            ├── MASTER_WAREHOUSE_LOCATION_NOT_EXIST("01001380001", "租户仓位不存在")
+            ├── MASTER_WAREHOUSE_LOCATION_CODE_FORMAT_CANNOT_EMPTY("01001380002", "仓位编码规则不能为空")
+            └── MASTER_WAREHOUSE_LOCATION_CODE_FORMAT_NOT_CORRECT("01001380003", "仓位编码规则格式不正确")
+```
+
+### Known Error Codes
+| Error Code | Error Message | Trigger Condition |
+|--------|----------|----------|
+| 01001380001 | Location does not exist | Detail query with non-existent ID |
+
+## 2.6 Permission Check
+
+| Check Item | Location | Description |
+|--------|------|------|
+| Page Query | No specific permission code on `@GetResource(path = "/page")` | Available to authenticated users |
+
+## 2.7 Implementation Notes
+
+1. **Pagination**: CLI uses 1-based page numbers. API uses 0-based. Convert: `pageNo = options.page - 1`.
+2. **Response Fields**: Backend returns `rows`, `pageNo`, `pageSize`, `totalRows`. Do NOT use `records` or `total`.
+3. **Warehouse Filter**: `--warehouse-id` is optional but commonly used to list locations within a specific warehouse.
+4. **Keyword Search**: When `--keyword` is provided, send it as both `warehouseLocationName` and `warehouseLocationCode` query params.
+5. **BigInteger IDs**: `warehouseLocationId` and `warehouseId` in response rows must be kept as `string` in TypeScript.
+6. **Table Output**: Default columns: Location ID, Warehouse ID, Code, Name, Status.
+7. **JSON Output**: When `--json` is used, wrap response with standardized pagination object.
+
+## 2.8 Example Usage
+
+```bash
+# List all locations (first page, 20 per page)
+barista liberica locations list
+
+# List locations for a specific warehouse
+barista liberica locations list --warehouse-id "1234567890123456789"
+
+# List with pagination
+barista liberica locations list --warehouse-id "1234567890123456789" --page 2 --size 50
+
+# Filter by status
+barista liberica locations list --status 1
+
+# Keyword search
+barista liberica locations list --keyword "A-01"
+
+# JSON output
+barista liberica locations list --json
+
+# Combine filters
+barista liberica locations list \
+  --warehouse-id "1234567890123456789" \
+  --page 1 \
+  --size 10 \
+  --status 1 \
+  --keyword "Shelf" \
+  --json
+```
+
+## 2.9 API Path
+
+```
+GET /api/enterprise/purchases/warehouse/location/page
+```
+
+**Query Parameters:**
+```
+?pageNo=0&pageSize=20&warehouseId=1234567890123456789&statusFlag=1&warehouseLocationCode=Shelf&warehouseLocationName=Shelf
+```
+
+**Headers:**
+```
+Authorization: <token>  (No "Bearer " prefix)
+```
+
+**Note**: Do NOT include `X-TENANT-ID` header. Tenant is extracted from JWT token.

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

@@ -0,0 +1,222 @@
+# barista liberica warehouses create
+
+Create a new warehouse.
+
+## 2.1 Command Metadata
+
+| Field | Value |
+|------|-----|
+| Full Command | `barista liberica warehouses create` |
+| Description | Create a new warehouse |
+| 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/stock/
+        └── EnterpriseWarehouseController.java
+            └── add(@PostResource(path = "/add", requiredPermission = true, requirePermissionCode = MasterWarehousePermissionConstants.ADD_MASTER_WAREHOUSE))
+                └── public ResponseData<MasterWarehouseResponse> add(
+                        @RequestHeader("X-TENANT-ID") Long tenantId,
+                        @RequestBody @Validated(BaseRequest.add.class) MasterWarehouseRequest masterWarehouseRequest
+                    )
+```
+
+### Request DTO Location
+```
+coffee-liberica-end/
+└── business/liberica-business-master/master-api/
+    └── src/main/java/com/newpeak/liberica/master/api/pojo/request/
+        └── MasterWarehouseRequest.java
+            ├── warehouseCode: String (@NotBlank on add, max=255)
+            ├── warehouseName: String (max=255)
+            ├── warehouseClasses: String (max=255)
+            ├── manager: String (max=255)
+            ├── warehouseTelephone: String (max=256)
+            ├── warehouseFax: String (max=256)
+            ├── warehouseAddress: String (max=512)
+            ├── enableLocation: String (@NotBlank on add, max=1, Y/N)
+            ├── enableNegativeInventory: String (max=1, Y/N)
+            ├── statusFlag: Integer
+            └── remark: String (max=255)
+```
+
+### Response DTO Location
+```
+coffee-liberica-end/
+└── business/liberica-business-master/master-api/
+    └── src/main/java/com/newpeak/liberica/master/api/pojo/response/
+        └── MasterWarehouseResponse.java
+            ├── warehouseId: Long
+            ├── warehouseCode: String
+            ├── warehouseName: String
+            ├── warehouseClasses: String
+            ├── manager: String
+            ├── warehouseTelephone: String
+            ├── warehouseFax: String
+            ├── warehouseAddress: String
+            ├── enableLocation: String (Y/N)
+            ├── enableNegativeInventory: String (Y/N)
+            ├── statusFlag: Integer (1=enable, 2=disable)
+            ├── remark: String
+            └── locations: List<MasterWarehouseLocationResponse>
+```
+
+## 2.3 CLI Parameter Design
+
+### Command Structure
+```
+barista liberica warehouses 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 |
+|------|--------|------|------|--------|------|-------------|
+| --code | -c | string | Yes | - | Warehouse code | warehouseCode |
+| --name | -n | string | Yes | - | Warehouse name | warehouseName |
+| --classes | — | string | No | - | Warehouse class/category | warehouseClasses |
+| --manager | -m | string | No | - | Warehouse manager | manager |
+| --phone | — | string | No | - | Warehouse telephone | warehouseTelephone |
+| --fax | — | string | No | - | Warehouse fax | warehouseFax |
+| --address | -a | string | No | - | Warehouse address | warehouseAddress |
+| --enable-location | — | boolean | Yes | true | Enable location management | enableLocation |
+| --enable-negative-inventory | — | boolean | No | false | Allow negative inventory | enableNegativeInventory |
+| --remark | -r | string | No | - | Remarks | remark |
+
+## 2.4 Field Mapping Table
+
+| CLI Parameter | DTO Field | Type Conversion | Validation Rule |
+|---------|---------|----------|----------|
+| --code / -c | warehouseCode | Direct | @NotBlank, max=255, unique per tenant |
+| --name / -n | warehouseName | Direct | max=255 |
+| --classes | warehouseClasses | Direct | max=255 |
+| --manager / -m | manager | Direct | max=255 |
+| --phone | warehouseTelephone | Direct | max=256 |
+| --fax | warehouseFax | Direct | max=256 |
+| --address / -a | warehouseAddress | Direct | max=512 |
+| --enable-location | enableLocation | boolean->String (Y/N) | @NotBlank, max=1 |
+| --enable-negative-inventory | enableNegativeInventory | boolean->String (Y/N) | max=1 |
+| --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) |
+
+## 2.5 Error Code Reference
+
+### ExceptionEnum Location
+```
+coffee-liberica-end/
+└── business/liberica-business-master/master-api/
+    └── src/main/java/com/newpeak/liberica/master/api/exception/enums/
+        └── MasterWarehouseExceptionEnum.java
+            ├── MASTER_WAREHOUSE_NOT_EXIST("01001370001", "租户仓库不存在")
+            ├── MASTER_WAREHOUSE_CODE_FORMAT_CANNOT_EMPTY("01001370002", "仓库编码规则不能为空")
+            └── MASTER_WAREHOUSE_CODE_FORMAT_NOT_CORRECT("01001370003", "仓库编码规则格式不正确")
+```
+
+### Known Error Codes
+| Error Code | Error Message | Trigger Condition |
+|--------|----------|----------|
+| 01001370001 | Warehouse does not exist | Edit/detail with non-existent ID |
+| 01001370002 | Warehouse code format cannot be empty | Auto-generation rule not configured |
+| 01001370003 | Warehouse code format incorrect | Invalid code format pattern |
+
+## 2.6 Permission Check
+
+| Check Item | Location | Description |
+|--------|------|------|
+| PermissionConstants | `MasterWarehousePermissionConstants.ADD_MASTER_WAREHOUSE` | Controller layer `@PostResource(requirePermissionCode = "ADD_MASTER_WAREHOUSE")` |
+
+## 2.7 Implementation Notes
+
+1. **Required Fields**: `--code` and `--name` must be provided. `--enable-location` defaults to true.
+2. **Manual Code**: `warehouseCode` is NOT auto-generated. User must provide a unique code.
+3. **Dry-Run Support**: Use `--dry-run` to preview request without calling API.
+4. **Boolean Flags**: `--enable-location` defaults to `true` (Y), `--enable-negative-inventory` defaults to `false` (N).
+5. **No Batch Create**: This command does NOT support batch creation (one warehouse per call).
+6. **BigInteger ID**: `warehouseId` in response must be parsed as `string` in TypeScript to avoid precision loss.
+
+## 2.8 Example Usage
+
+```bash
+# Create with minimal required fields
+barista liberica warehouses create --code "WH-001" --name "Main Warehouse"
+
+# Create with all common options
+barista liberica warehouses create \
+  --code "WH-002" \
+  --name "East Storage" \
+  --classes "FINISHED_GOOD" \
+  --manager "John Doe" \
+  --phone "021-12345678" \
+  --address "123 Industrial Road" \
+  --enable-location \
+  --enable-negative-inventory \
+  --remark "Primary finished goods storage"
+
+# Disable location management
+barista liberica warehouses create \
+  --code "WH-003" \
+  --name "Bulk Storage" \
+  --no-enable-location
+
+# Dry-run to preview
+barista liberica warehouses create \
+  --code "WH-004" \
+  --name "Test Warehouse" \
+  --dry-run
+
+# JSON output
+barista liberica warehouses create \
+  --code "WH-005" \
+  --name "New Warehouse" \
+  --json
+```
+
+## 2.9 Request Body Structure
+
+```json
+{
+  "warehouseCode": "WH-001",
+  "warehouseName": "Main Warehouse",
+  "warehouseClasses": "FINISHED_GOOD",
+  "manager": "John Doe",
+  "warehouseTelephone": "021-12345678",
+  "warehouseFax": "021-87654321",
+  "warehouseAddress": "123 Industrial Road",
+  "enableLocation": "Y",
+  "enableNegativeInventory": "N",
+  "statusFlag": 1,
+  "remark": "Primary storage"
+}
+```
+
+## 2.10 API Path
+
+```
+POST /api/enterprise/purchases/warehouse/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.