Add return type for CancelMerchOrder

api/controllers/MerchStoreController.ts

@@ -49,6 +49,7 @@ import {
   CompleteOrderPickupEventResponse,
   GetOrderPickupEventResponse,
   CancelOrderPickupEventResponse,
+  CancelMerchOrderResponse,
 } from '../../types';
 import { UuidParam } from '../validators/GenericRequests';
 import { AuthenticatedUser } from '../decorators/AuthenticatedUser';
@@ -309,10 +310,11 @@ export class MerchStoreController {
   }
 
   @Post('/order/:uuid/cancel')
-  async cancelMerchOrder(@Params() params: UuidParam, @AuthenticatedUser() user: UserModel) {
+  async cancelMerchOrder(@Params() params: UuidParam,
+    @AuthenticatedUser() user: UserModel): Promise<CancelMerchOrderResponse> {
     if (!PermissionsService.canAccessMerchStore(user)) throw new ForbiddenError();
     const order = await this.merchStoreService.cancelMerchOrder(params.uuid, user);
-    return { error: null, order };
+    return { error: null, order: order.getPublicOrderWithItems() };
   }
 
   @Post('/order/:uuid/fulfill')

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@acmucsd/membership-portal",
-  "version": "3.4.4",
+  "version": "3.4.5",
   "description": "REST API for ACM UCSD's membership portal.",
   "main": "index.d.ts",
   "files": [

services/MerchStoreService.ts

@@ -761,7 +761,7 @@ export default class MerchStoreService {
   /**
    * Cancels a merch order, refunding the user of its credits if the user is the one who cancelled the order.
    */
-  public async cancelMerchOrder(orderUuid: Uuid, user: UserModel): Promise<void> {
+  public async cancelMerchOrder(orderUuid: Uuid, user: UserModel): Promise<OrderModel> {
     return this.transactions.readWrite(async (txn) => {
       const orderRespository = Repositories.merchOrder(txn);
       const order = await orderRespository.findByUuid(orderUuid);
@@ -785,6 +785,7 @@ export default class MerchStoreService {
         type: ActivityType.ORDER_CANCELLED,
         description: `Order ${order.uuid} cancelled and refunded to ${customer.uuid} by ${user.uuid}`,
       });
+      return order;
     });
   }
 

tests/merchOrder.test.ts

@@ -442,7 +442,8 @@ describe('merch orders', () => {
 
     // cancel order
     const { uuid } = placedOrderResponse.order;
-    await merchController.cancelMerchOrder({ uuid }, member);
+    const cancelOrderResponse = await merchController.cancelMerchOrder({ uuid }, member);
+    expect(cancelOrderResponse.order.uuid).toEqual(uuid);
 
     // get order, making sure state was updated and user has been refunded
     const cancelledOrderResponse = await merchController.getOneMerchOrder({ uuid }, member);
@@ -518,7 +519,8 @@ describe('merch orders', () => {
 
     // cancel the order
     const { uuid } = placedOrderResponse.order;
-    await merchController.cancelMerchOrder({ uuid }, member);
+    const cancelOrderResponse = await merchController.cancelMerchOrder({ uuid }, member);
+    expect(cancelOrderResponse.order.uuid).toEqual(uuid);
 
     // make sure user has only been refunded 1 option worth of points
     await member.reload();
@@ -890,7 +892,8 @@ describe('merch orders', () => {
     const merchController = ControllerFactory.merchStore(conn, instance(emailService));
     const placedOrder = await conn.manager.findOne(OrderModel, { user: member }, { relations: ['items'] });
     const cancelOrderParams = { uuid: placedOrder.uuid };
-    await merchController.cancelMerchOrder(cancelOrderParams, member);
+    const cancelOrderResponse = await merchController.cancelMerchOrder(cancelOrderParams, member);
+    expect(cancelOrderResponse.order.uuid).toEqual(cancelOrderParams.uuid);
 
     // place order with 2 items again
     const secondOrder = [{ option: option.uuid, quantity: 2 }];

types/ApiResponses.ts

@@ -311,6 +311,10 @@ export interface VerifyMerchOrderResponse extends ApiResponse {}
 
 export interface EditMerchOrderResponse extends ApiResponse {}
 
+export interface CancelMerchOrderResponse extends ApiResponse {
+  order: PublicOrderWithItems;
+}
+
 export interface GetCartResponse extends ApiResponse {
   cart: PublicOrderMerchItemOption[];
 }