Feat(medusa): remove item from order (#2273)

* wait for update to order edit model * delete line item tests * create remove method for lineitem with tax lines * add remove item tests * split delete allocation tests into two: more and less than total * remove unused import * cleanup * add medusa-js and react endpoints * pr feedback fixes * linting * remove unused relation from query * remove removed-event and unused imports * add await
2022-09-30 09:48:18 +02:00
parent 95c0dc653a
commit 00959f79bc
15 changed files with 811 additions and 11 deletions
@@ -0,0 +1,42 @@
+import { IdMap } from "medusa-test-utils"
+import { request } from "../../../../../helpers/test-request"
+import OrderEditingFeatureFlag from "../../../../../loaders/feature-flags/order-editing"
+import { orderEditServiceMock } from "../../../../../services/__mocks__/order-edit"
+
+describe("DELETE /admin/order-edits/:id/items/:item_id", () => {
+  describe("deletes a line item", () => {
+    const lineItemId = IdMap.getId("testLineItem")
+    const orderEditId = IdMap.getId("testCreatedOrder")
+    let subject
+
+    beforeAll(async () => {
+      subject = await request("DELETE", `/admin/order-edits/${orderEditId}/items/${lineItemId}`, {
+        adminSession: {
+          jwt: {
+            userId: IdMap.getId("admin_user"),
+          },
+        },
+        flags: [OrderEditingFeatureFlag],
+      })
+    })
+
+    afterAll(() => {
+      jest.clearAllMocks()
+    })
+
+    it("calls orderService removeLineItem", () => {
+      expect(orderEditServiceMock.removeLineItem).toHaveBeenCalledTimes(1)
+      expect(orderEditServiceMock.removeLineItem).toHaveBeenCalledWith(orderEditId, lineItemId)
+    })
+
+    it("returns 200", () => {
+      expect(subject.status).toEqual(200)
+    })
+
+    it("returns retrieve result", () => {
+      expect(subject.body.order_edit).toEqual(expect.objectContaining({
+        id: orderEditId, 
+      }))
+    })
+  })
+})
@@ -0,0 +1,85 @@
+import { EntityManager } from "typeorm"
+import { OrderEditService } from "../../../../services"
+import { Request, Response } from "express"
+import { IsNumber } from "class-validator"
+import {
+  defaultOrderEditFields,
+  defaultOrderEditRelations,
+} from "../../../../types/order-edit"
+
+/**
+ * @oas [delete] /order-edits/{id}/items/{item_id}
+ * operationId: "DeleteOrderEditsOrderEditLineItemsLineItem"
+ * summary: "Delete line items from an order edit and create change item"
+ * description: "Delete line items from an order edit and create change item"
+ * x-authenticated: true
+ * parameters:
+ *   - (path) id=* {string} The ID of the Order Edit to delete from.
+ *   - (path) item_id=* {string} The ID of the order edit item to delete from order.
+ * x-codeSamples:
+ *   - lang: JavaScript
+ *     label: JS Client
+ *     source: |
+ *       import Medusa from "@medusajs/medusa-js"
+ *       const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
+ *       // must be previously logged in or use api token
+ *       medusa.admin.orderEdits.removeLineItem(order_edit_id, line_item_id)
+ *         .then(({ order_edit }) => {
+ *           console.log(order_edit.id)
+ *         })
+ *   - lang: Shell
+ *     label: cURL
+ *     source: |
+ *       curl --location --request DELETE 'https://medusa-url.com/admin/order-edits/{id}/items/{item_id}' \
+ *       --header 'Authorization: Bearer {api_token}'
+ * security:
+ *   - api_token: []
+ *   - cookie_auth: []
+ * tags:
+ *   - OrderEdit
+ * responses:
+ *   200:
+ *     description: OK
+ *     content:
+ *       application/json:
+ *         schema:
+ *           properties:
+ *             order_edit:
+ *               $ref: "#/components/schemas/order_edit"
+ *   "400":
+ *     $ref: "#/components/responses/400_error"
+ *   "401":
+ *     $ref: "#/components/responses/unauthorized"
+ *   "404":
+ *     $ref: "#/components/responses/not_found_error"
+ *   "409":
+ *     $ref: "#/components/responses/invalid_state_error"
+ *   "422":
+ *     $ref: "#/components/responses/invalid_request_error"
+ *   "500":
+ *     $ref: "#/components/responses/500_error"
+ */
+export default async (req: Request, res: Response) => {
+  const { id, item_id } = req.params
+
+  const orderEditService: OrderEditService =
+    req.scope.resolve("orderEditService")
+
+  const manager: EntityManager = req.scope.resolve("manager")
+
+  await manager.transaction(async (transactionManager) => {
+    await orderEditService
+      .withTransaction(transactionManager)
+      .removeLineItem(id, item_id)
+  })
+
+  let orderEdit = await orderEditService.retrieve(id, {
+    select: defaultOrderEditFields,
+    relations: defaultOrderEditRelations,
+  })
+  orderEdit = await orderEditService.decorateTotals(orderEdit)
+
+  res.status(200).send({
+    order_edit: orderEdit,
+  })
+}
@@ -82,6 +82,11 @@ export default (app) => {
    middlewares.wrap(require("./update-order-edit-line-item").default)
  )

+  route.delete(
+    "/:id/items/:item_id",
+    middlewares.wrap(require("./delete-line-item").default)
+  )
+
  return app
 }

@@ -14,7 +14,7 @@ import {
 * description: "Create or update the order edit change holding the line item changes"
 * x-authenticated: true
 * parameters:
- *   - (path) id=* {string} The ID of the Order Edit to delete.
+ *   - (path) id=* {string} The ID of the Order Edit to update.
 *   - (path) item_id=* {string} The ID of the order edit item to update.
 * x-codeSamples:
 *   - lang: JavaScript
@@ -30,7 +30,7 @@ import {
 *   - lang: Shell
 *     label: cURL
 *     source: |
- *       curl --location --request DELETE 'https://medusa-url.com/admin/order-edits/{id}/items/{item_id}' \
+ *       curl --location --request POST 'https://medusa-url.com/admin/order-edits/{id}/items/{item_id}' \
 *       --header 'Authorization: Bearer {api_token}'
 *       -d '{ "quantity": 5 }'
 * security:
@@ -22,10 +22,6 @@ export default (app, featureFlagRouter: FlagRouter) => {
    relations.push("sales_channel")
  }

-  if (featureFlagRouter.isFeatureEnabled(OrderEditingFeatureFlag.key)) {
-    relations.push("edits")
-  }
-
  /**
   * List orders
   */