@things-factory/operato-hub 4.3.626 → 4.3.629

package/server/routers/api/restful-apis/v1/utils/params.ts

@@ -633,6 +633,30 @@ export const params = {
     'sellerDiscount',
     'shippingFee',
     'actualShippingFee'
+  ],
+  'add-return-order': [
+    'bizplaceId',
+    'releaseGoodName',
+    'orderInventories',
+    'orderInventories.productDetail',
+    'orderInventories.productDetail.id',
+    'orderInventories.returnQty',
+    'orderInventories.batchId',
+    'remark',
+    'ownTransport',
+    'warehouseTransport',
+    'collectionOrderNo'
+  ],
+  'get-return-order-list': [
+    'bizplaceId',
+    'name',
+    ...fromToDate,
+    ...limitOffset
+  ],
+  'get-return-order-details': [
+    'bizplaceId',
+    'id',
+    'returnOrderNo'
   ]
 }
 
@@ -1106,7 +1130,13 @@ export const reqParams = {
         { name: 'paidPrice', required: true, type: 'field' }
       ]
     }
-  ]
+  ],
+  'add-return-order': [
+    { name: 'bizplaceId', required: true, type: 'field' },
+    { name: 'releaseGoodName', required: true, type: 'field' }
+  ],
+  'get-return-order-list': ['bizplaceId'],
+  'get-return-order-details': []
 }
 
 // Require Offset
@@ -1124,7 +1154,8 @@ export const requireLimitOffsetValidation = [
   'get-contact-point-list',
   'get-bizplace-list',
   'get-draft-order-list',
-  'get-inventory-adjustment-list'
+  'get-inventory-adjustment-list',
+  'get-return-order-list'
 ]
 
 // Require fromDate and toDate
@@ -1135,5 +1166,6 @@ export const requireFromToDateValidation = [
   'get-delivery-order-list',
   'get-marketplace-order-shipping-list',
   'get-draft-order-list',
-  'get-inventory-adjustment-list'
+  'get-inventory-adjustment-list',
+  'get-return-order-list'
 ]

package/server/routers/api/restful-apis/v1/warehouse/add-return-order.ts

@@ -0,0 +1,360 @@
+import { EntityManager, getConnection, In } from 'typeorm'
+
+import { restfulApiRouter as router } from '@things-factory/api'
+import { User } from '@things-factory/auth-base'
+import { Bizplace } from '@things-factory/biz-base'
+import { ORDER_STATUS, generateReturnOrder, ReleaseGood } from '@things-factory/sales-base'
+import { Domain } from '@things-factory/shell'
+
+import { businessMiddleware, loggingMiddleware, validationMiddleware } from '../middlewares'
+import { ApiError, ApiErrorHandler, throwInternalServerError } from '../utils/error-util'
+
+router.post(
+  '/v1/warehouse/add-return-order',
+  businessMiddleware,
+  validationMiddleware,
+  loggingMiddleware,
+  async (context, next) => {
+    try {
+      const { domain, user } = context.state
+      const bodyReq = context.request.body.data
+
+      // // Basic validations before 
+      // Transport type validations
+      if (!bodyReq.ownTransport && !bodyReq.warehouseTransport) {
+        throw new ApiError('E01', 'Please select a transport type')
+      }
+
+      if (bodyReq.ownTransport && bodyReq.warehouseTransport) {
+        throw new ApiError('E01', 'You can only select one transport type')
+      }
+
+      // // Order inventories basic validations
+      if (!bodyReq.orderInventories || !Array.isArray(bodyReq.orderInventories) || bodyReq.orderInventories.length === 0) {
+        throw new ApiError('E01', 'orderInventories is required and must be a non-empty array')
+      }
+
+      // Validate each inventory item's required fields
+      for (const returnItem of bodyReq.orderInventories) {
+        if (!returnItem.productDetail || !returnItem.productDetail.id) {
+          throw new ApiError('E01', 'productDetail.id is required for each order inventory')
+        }
+
+        if (!returnItem.returnQty || returnItem.returnQty <= 0) {
+          throw new ApiError('E01', 'returnQty must be greater than 0 for each order inventory')
+        }
+
+        if (!returnItem.batchId) {
+          throw new ApiError('E01', 'batchId is required for each order inventory')
+        }
+      }
+
+      await getConnection().transaction(async (tx: EntityManager) => {
+        // 1. Get customer bizplace
+        const customerBizplace: Bizplace = await tx.getRepository(Bizplace).findOne({
+          where: { id: bodyReq.bizplaceId },
+          relations: ['domain']
+        })
+
+        if (!customerBizplace) {
+          throw new ApiError('E04', 'customer bizplace not found')
+        }
+
+        // 2. Get release good details and validate
+        const releaseGood: ReleaseGood = await tx.getRepository(ReleaseGood).findOne({
+          where: {
+            domain,
+            name: bodyReq.releaseGoodName,
+            bizplace: customerBizplace,
+            status: In([ORDER_STATUS.DONE])
+          },
+          relations: [
+            'orderInventories',
+            'orderInventories.product',
+            'orderInventories.productDetail',
+            'orderInventories.inventory',
+            'orderInventories.inventory.product',
+            'orderInventories.inventory.product.productDetails'
+          ]
+        })
+
+        if (!releaseGood) {
+          throw new ApiError('E04', `Release good ${bodyReq.releaseGoodName} not found`)
+        }
+
+        // 3. Validate each return item against original order (by productDetailId only)
+        for (const returnItem of bodyReq.orderInventories) {
+          const originalOrderInventory = releaseGood.orderInventories.find(oi =>
+            oi.productDetail && oi.productDetail.id === returnItem.productDetail.id && oi.inventory.batchId === returnItem.batchId
+          )
+
+          if (!originalOrderInventory) {
+            throw new ApiError('E01', `productDetail.id:${returnItem.productDetail.id} with batchId:${returnItem.batchId} was not found in the original order`)
+          }
+
+          if (returnItem.returnQty > originalOrderInventory.releaseQty) {
+            throw new ApiError('E01', `Return quantity ${returnItem.returnQty} exceeds original order quantity ${originalOrderInventory.releaseQty} for product detail ${returnItem.productDetail.id}`)
+          }
+
+          returnItem.product = originalOrderInventory.product
+        }
+
+        // 4. Prepare return order data
+        const returnOrder = {
+          customerBizplaceId: bodyReq.bizplaceId,
+          orderInventories: bodyReq.orderInventories,
+          remark: bodyReq.remark || null,
+          ownTransport: bodyReq.ownTransport || false,
+          collectionOrderNo: bodyReq.collectionOrderNo || null
+        }
+
+        // 5. Generate return order
+        const result = await generateReturnOrder(tx, domain, user, returnOrder, [], context)
+
+        // 6. Prepare response data
+        const data = {
+          id: result.id,
+          name: result.name,
+          status: result.status,
+          remark: result.remark,
+          ownTransport: result.ownTransport,
+          collectionOrderNo: result.collectionOrderNo,
+          bizplace: { name: result.bizplace.name },
+          domain: { name: result.domain.name }
+        }
+
+        context.body = {
+          responseCode: '200',
+          message: 'success',
+          data
+        }
+      })
+    } catch (e) {
+      if (e instanceof ApiError) {
+        ApiErrorHandler(context, e)
+      } else {
+        throwInternalServerError(context, e)
+      }
+    }
+  }
+)
+
+// Sample Request:
+// POST /api/v1/warehouse/add-return-order
+// Headers: 
+//   Content-Type: application/json
+//   Authorization: Bearer <token>
+// Body:
+// {
+//   "bizplaceId": "123e4567-e89b-12d3-a456-426614174000",
+//   "releaseGoodName": "RG-2023001",
+//   "orderInventories": [
+//     {
+//       "productDetail": {
+//         "id": "987e6543-e21b-12d3-a456-426614174999"
+//       },
+//       "returnQty": 10,
+//       "batchId": "batch-001"
+//     }
+//   ],
+//   "remark": "Customer returned items due to defect",
+//   "ownTransport": true,
+//   "collectionOrderNo": "COL-123456"
+// }
+
+// Sample Postman Test Cases:
+// Test Case 1: Valid Return Order with Single Inventory
+// Description: Test the creation of a return order with valid data and a single inventory item.
+// Method: POST
+// URL: http://<server-url>/api/v1/warehouse/add-return-order
+// Headers:
+//   Content-Type: application/json
+//   Authorization: Bearer <token>
+// Body:
+// {
+//   "bizplaceId": "123e4567-e89b-12d3-a456-426614174000",
+//   "releaseGoodName": "RG-2023001",
+//   "orderInventories": [
+//     {
+//       "productDetail": {
+//         "id": "987e6543-e21b-12d3-a456-426614174999"
+//       },
+//       "returnQty": 10,
+//       "batchId": "batch-001"
+//     }
+//   ],
+//   "remark": "Customer returned items due to defect",
+//   "ownTransport": true,
+//   "collectionOrderNo": "COL-123456"
+// }
+
+// Test Case 2: Valid Return Order with Multiple Inventories
+// Description: Test the creation of a return order with valid data and multiple inventory items.
+// Method: POST
+// URL: http://<server-url>/api/v1/warehouse/add-return-order
+// Headers:
+//   Content-Type: application/json
+//   Authorization: Bearer <token>
+// Body:
+// {
+//   "bizplaceId": "123e4567-e89b-12d3-a456-426614174000",
+//   "releaseGoodName": "RG-2023001",
+//   "orderInventories": [
+//     {
+//       "productDetail": {
+//         "id": "987e6543-e21b-12d3-a456-426614174999"
+//       },
+//       "returnQty": 10,
+//       "batchId": "batch-001"
+//     },
+//     {
+//       "productDetail": {
+//         "id": "123e4567-e89b-12d3-a456-426614174998"
+//       },
+//       "returnQty": 5,
+//       "batchId": "batch-002"
+//     }
+//   ],
+//   "remark": "Customer returned items due to defect",
+//   "ownTransport": true,
+//   "collectionOrderNo": "COL-123456"
+// }
+
+// Test Case 3: Missing Bizplace ID
+// Description: Test the creation of a return order without a bizplace ID.
+// Method: POST
+// URL: http://<server-url>/api/v1/warehouse/add-return-order
+// Headers:
+//   Content-Type: application/json
+//   Authorization: Bearer <token>
+// Body:
+// {
+//   "releaseGoodName": "RG-2023001",
+//   "orderInventories": [
+//     {
+//       "productDetail": {
+//         "id": "987e6543-e21b-12d3-a456-426614174999"
+//       },
+//       "returnQty": 10,
+//       "batchId": "batch-001"
+//     }
+//   ],
+//   "remark": "Customer returned items due to defect",
+//   "ownTransport": true,
+//   "collectionOrderNo": "COL-123456"
+// }
+
+// Test Case 4: Invalid Return Quantity
+// Description: Test the creation of a return order with a negative return quantity.
+// Method: POST
+// URL: http://<server-url>/api/v1/warehouse/add-return-order
+// Headers:
+//   Content-Type: application/json
+//   Authorization: Bearer <token>
+// Body:
+// {
+//   "bizplaceId": "123e4567-e89b-12d3-a456-426614174000",
+//   "releaseGoodName": "RG-2023001",
+//   "orderInventories": [
+//     {
+//       "productDetail": {
+//         "id": "987e6543-e21b-12d3-a456-426614174999"
+//       },
+//       "returnQty": -5,
+//       "batchId": "batch-001"
+//     }
+//   ],
+//   "remark": "Customer returned items due to defect",
+//   "ownTransport": true,
+//   "collectionOrderNo": "COL-123456"
+// }
+
+// Test Case 5: Missing Order Inventories
+// Description: Test the creation of a return order without order inventories.
+// Method: POST
+// URL: http://<server-url>/api/v1/warehouse/add-return-order
+// Headers:
+//   Content-Type: application/json
+//   Authorization: Bearer <token>
+// Body:
+// {
+//   "bizplaceId": "123e4567-e89b-12d3-a456-426614174000",
+//   "releaseGoodName": "RG-2023001",
+//   "remark": "Customer returned items due to defect",
+//   "ownTransport": true,
+//   "collectionOrderNo": "COL-123456"
+// }
+
+// Test Case 6: Invalid Product Detail ID
+// Description: Test the creation of a return order with an invalid productDetail.id.
+// Method: POST
+// URL: http://<server-url>/api/v1/warehouse/add-return-order
+// Headers:
+//   Content-Type: application/json
+//   Authorization: Bearer <token>
+// Body:
+// {
+//   "bizplaceId": "123e4567-e89b-12d3-a456-426614174000",
+//   "releaseGoodName": "RG-2023001",
+//   "orderInventories": [
+//     {
+//       "productDetail": {
+//         "id": "invalid-product-detail-id"
+//       },
+//       "returnQty": 10,
+//       "batchId": "batch-001"
+//     }
+//   ],
+//   "remark": "Customer returned items due to defect",
+//   "ownTransport": true,
+//   "collectionOrderNo": "COL-123456"
+// }
+
+// Test Case 7: Missing Release Good Name
+// Description: Test the creation of a return order without a release good name.
+// Method: POST
+// URL: http://<server-url>/api/v1/warehouse/add-return-order
+// Headers:
+//   Content-Type: application/json
+//   Authorization: Bearer <token>
+// Body:
+// {
+//   "bizplaceId": "123e4567-e89b-12d3-a456-426614174000",
+//   "orderInventories": [
+//     {
+//       "productDetail": {
+//         "id": "987e6543-e21b-12d3-a456-426614174999"
+//       },
+//       "returnQty": 10,
+//       "batchId": "batch-001"
+//     }
+//   ],
+//   "remark": "Customer returned items due to defect",
+//   "ownTransport": true,
+//   "collectionOrderNo": "COL-123456"
+// }
+
+// Test Case 8: Invalid Release Good Name
+// Description: Test the creation of a return order with a non-existent release good name.
+// Method: POST
+// URL: http://<server-url>/api/v1/warehouse/add-return-order
+// Headers:
+//   Content-Type: application/json
+//   Authorization: Bearer <token>
+// Body:
+// {
+//   "bizplaceId": "123e4567-e89b-12d3-a456-426614174000",
+//   "releaseGoodName": "INVALID-RG-2023001",
+//   "orderInventories": [
+//     {
+//       "productDetail": {
+//         "id": "987e6543-e21b-12d3-a456-426614174999"
+//       },
+//       "returnQty": 10,
+//       "batchId": "batch-001"
+//     }
+//   ],
+//   "remark": "Customer returned items due to defect",
+//   "ownTransport": true,
+//   "collectionOrderNo": "COL-123456"
+// }

package/server/routers/api/restful-apis/v1/warehouse/get-return-order-details.ts

@@ -0,0 +1,99 @@
+import _ from 'lodash'
+import { getRepository } from 'typeorm'
+import { ReturnOrder } from '@things-factory/sales-base'
+
+import { restfulApiRouter as router } from '@things-factory/api'
+import { businessMiddleware, loggingMiddleware, validationMiddleware } from '../middlewares'
+import { ApiError, ApiErrorHandler, throwInternalServerError } from '../utils/error-util'
+
+router.get(
+  '/v1/warehouse/get-return-order-details',
+  businessMiddleware,
+  validationMiddleware,
+  loggingMiddleware,
+  async (context, next) => {
+    try {
+      const { domain } = context.state
+      let filter = { ...context.query, domain: domain.id }
+      if (filter.bizplaceId) {
+        filter['bizplace'] = filter['bizplaceId']
+        delete filter['bizplaceId']
+      }
+      if (filter.id) {
+        filter['id'] = filter['id']
+      }
+
+      if (filter.returnOrderNo) {
+        filter['name'] = filter['returnOrderNo']
+        delete filter['returnOrderNo']
+      }
+
+      if (!filter.id && !filter.name) {
+        throw new ApiError('E01', 'return order number or id is required')
+      }
+
+      const returnOrder: ReturnOrder = await getRepository(ReturnOrder).findOne({
+        where: filter,
+        relations: [
+          'bizplace',
+          'orderInventories',
+          'orderInventories.product',
+          'orderInventories.productDetail',
+          'creator',
+          'updater',
+          'acceptedBy'
+        ]
+      })
+      if (!returnOrder) {
+        throw new ApiError('E04', 'return order')
+      }
+      // Flatten inventoryInfos for frontend
+      const itemInfos = (returnOrder.orderInventories || []).map(orderInv => {
+        return {
+          batchId: orderInv.batchId,
+          product: {
+            id: orderInv.product.id,
+            sku: orderInv.product.sku,
+            brandSku: orderInv.product?.brandSku,
+            brand: orderInv.product?.brand,
+            subBrand: orderInv.product?.subBrand
+          },
+          productDetail: {
+            id: orderInv.productDetail.id,
+            refCode: orderInv.productDetail.refCode,
+            isDefault: orderInv.productDetail?.isDefault,
+            packingType: orderInv.productDetail.packingType,
+            packingSize: orderInv.productDetail.packingSize,
+            movement: orderInv.productDetail?.movement,
+            uom: orderInv.productDetail?.uom,
+            uomValue: orderInv.productDetail?.uomValue
+          },
+          returnQty: orderInv.returnQty,
+          remark: orderInv.remark,
+          status: orderInv.status
+        }
+      })
+      const data = {
+        id: returnOrder.id,
+        name: returnOrder.name,
+        status: returnOrder.status,
+        ownTransport: returnOrder.ownTransport,
+        eta: returnOrder.eta,
+        etaDate: returnOrder.etaDate,
+        remark: returnOrder.remark,
+        refNo: returnOrder.refNo,
+        bizplace: returnOrder.bizplace ? { id: returnOrder.bizplace.id, name: returnOrder.bizplace.name } : null,
+        creator: returnOrder.creator ? { id: returnOrder.creator.id, name: returnOrder.creator.name } : null,
+        updater: returnOrder.updater ? { id: returnOrder.updater.id, name: returnOrder.updater.name } : null,
+        acceptedBy: returnOrder.acceptedBy ? { id: returnOrder.acceptedBy.id, name: returnOrder.acceptedBy.name } : null,
+        createdAt: returnOrder.createdAt,
+        updatedAt: returnOrder.updatedAt,
+        itemInfos
+      }
+      context.body = { data }
+    } catch (e) {
+      if (e instanceof ApiError) ApiErrorHandler(context, e)
+      else throwInternalServerError(context, e)
+    }
+  }
+)

package/server/routers/api/restful-apis/v1/warehouse/get-return-order-list.ts

@@ -0,0 +1,68 @@
+import _ from 'lodash'
+import { Between, getRepository } from 'typeorm'
+
+import { restfulApiRouter as router } from '@things-factory/api'
+import { ReturnOrder } from '@things-factory/sales-base'
+
+import { businessMiddleware, loggingMiddleware, validationMiddleware } from '../middlewares'
+import { ApiError, ApiErrorHandler, throwInternalServerError } from '../utils/error-util'
+
+router.get(
+  '/v1/warehouse/get-return-order-list',
+  businessMiddleware,
+  validationMiddleware,
+  loggingMiddleware,
+  async (context, next) => {
+    try {
+      let filter = { ...context.query }
+      const { fromDate, toDate, offset, limit } = filter
+      if (filter.bizplaceId) {
+        filter['bizplace'] = filter['bizplaceId']
+        delete filter['bizplaceId']
+      }
+      if (filter.name) {
+        filter['name'] = filter['name']
+      }
+      if (fromDate && toDate) {
+        filter['createdAt'] = Between(fromDate, toDate)
+      }
+      delete filter['fromDate']
+      delete filter['toDate']
+      delete filter['limit']
+      delete filter['offset']
+      
+      const [returnOrders, totalCount]: [ReturnOrder[], number] = await getRepository(ReturnOrder).findAndCount({
+        where: filter,
+        relations: ['bizplace', 'creator', 'updater', 'acceptedBy'],
+        skip: offset ? Number(offset) : 0,
+        take: limit ? Number(limit) : 100,
+        order: { createdAt: 'DESC' }
+      })
+      const data = returnOrders.map(ro => ({
+        id: ro.id,
+        name: ro.name,
+        status: ro.status,
+        ownTransport: ro.ownTransport,
+        eta: ro.eta,
+        etaDate: ro.etaDate,
+        remark: ro.remark,
+        refNo: ro.refNo,
+        bizplace: ro.bizplace ? { id: ro.bizplace.id, name: ro.bizplace.name } : null,
+        creator: ro.creator ? { id: ro.creator.id, name: ro.creator.name } : null,
+        updater: ro.updater ? { id: ro.updater.id, name: ro.updater.name } : null,
+        acceptedBy: ro.acceptedBy ? { id: ro.acceptedBy.id, name: ro.acceptedBy.name } : null,
+        createdAt: ro.createdAt,
+        updatedAt: ro.updatedAt
+      }))
+      context.body = {
+        data,
+        totalCount,
+        limit: limit ? Number(limit) : 100,
+        offset: offset ? Number(offset) : 0
+      }
+    } catch (e) {
+      if (e instanceof ApiError) ApiErrorHandler(context, e)
+      else throwInternalServerError(context, e)
+    }
+  }
+)

package/server/routers/api/restful-apis/v1/warehouse/index.ts

@@ -1,26 +1,29 @@
 import './add-inbound-order'
 import './add-release-order'
+import './add-return-order'
+import './add-sales-invoice'
 import './cancel-inbound-order'
 import './cancel-release-order'
+import './complete-delivery-order'
+import './dispatch-delivery-order'
 import './get-delivery-order-list'
+import './get-do-document'
+import './get-draft-order-details'
 import './get-draft-order-list'
 import './get-goods-received-note-list'
+import './get-grn-document'
 import './get-inbound-order-details'
 import './get-inbound-order-list'
+import './get-inventory-adjustment-details'
+import './get-inventory-adjustment-list'
 import './get-inventory-product-group-list'
+import './get-manifest-details'
 import './get-onhand-inventory-list'
-import './get-draft-order-details'
 import './get-release-order-details'
 import './get-release-order-list'
+import './get-return-order-details'
+import './get-return-order-list'
 import './get-warehouse-bizplace-onhand-inventories'
-import './update-release-order-details'
-import './get-grn-document'
-import './get-do-document'
-import './dispatch-delivery-order'
 import './update-gan-to-arrived'
-import './complete-delivery-order'
-import './get-inventory-adjustment-list'
-import './get-inventory-adjustment-details'
-import './get-manifest-details'
 import './update-order-package-details'
-import './add-sales-invoice'
+import './update-release-order-details'