asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Feat(medusa, medusa-js, medusa-react): order edit item update (#2246)

Browse Source 
**what**
Support `updateLineItem` which does the following:
- If no item change exist then create a new one and attaches the clone item with the adjustments and tax lines
- if an item change exists then delete/create adjustments and tax lines and update the cloned item quantity

**Tests**
- Unit tests core + client
- integration tests
  - When no item change already exists
  - When an item change already exists

FIXES CORE-497
This commit is contained in:
Adrien de Peretti
2022-09-28 09:09:33 +00:00
committed by GitHub
parent 1807bff029
commit 474e97252c
24 changed files with 1247 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/medusa/src/api/routes/admin/order-edits/__tests__/update-order-edit-line-item.ts
+47
View File
@@ -0,0 +1,47 @@
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("POST /admin/order-edits/:id/items/:item_id", () => {
describe("update line item and create an item change of type update", () => {
const orderEditId = IdMap.getId("test-order-edit")
const lineItemId = IdMap.getId("line-item")
let subject
beforeAll(async () => {
subject = await request(
"POST",
`/admin/order-edits/${orderEditId}/items/${lineItemId}`,
{
payload: {
quantity: 3,
},
adminSession: {
jwt: {
userId: IdMap.getId("admin_user"),
},
},
flags: [OrderEditingFeatureFlag],
}
)
})
afterAll(() => {
jest.clearAllMocks()
})
it("calls orderEditService updateLineItem", () => {
expect(orderEditServiceMock.updateLineItem).toHaveBeenCalledTimes(1)
expect(orderEditServiceMock.updateLineItem).toHaveBeenCalledWith(
orderEditId,
lineItemId,
{ quantity: 3 }
)
})
it("returns 200", () => {
expect(subject.status).toEqual(200)
})
})
})
packages/medusa/src/api/routes/admin/order-edits/create-order-edit.ts
+3 -3
View File
@@ -21,9 +21,9 @@ import {
* const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
* // must be previously logged in or use api token
* medusa.admin.orderEdit.create({ order_id, internal_note })
* .then(({ order_edit }) => {
* console.log(order_edit.id);
* });
* .then(({ order_edit }) => {
* console.log(order_edit.id)
* })
* - lang: Shell
* label: cURL
* source: |
packages/medusa/src/api/routes/admin/order-edits/delete-order-edit-item-change.ts
+3 -3
View File
@@ -18,9 +18,9 @@ import { OrderEditService } from "../../../../services"
* const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
* // must be previously logged in or use api token
* medusa.admin.orderEdits.deleteItemChange(item_change_id, order_edit_id)
* .then(({ id, object, deleted }) => {
* console.log(id);
* });
* .then(({ id, object, deleted }) => {
* console.log(id)
* })
* - lang: Shell
* label: cURL
* source: |
packages/medusa/src/api/routes/admin/order-edits/delete-order-edit.ts
+3 -3
View File
@@ -17,9 +17,9 @@ import { OrderEditService } from "../../../../services"
* const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
* // must be previously logged in or use api token
* medusa.admin.orderEdits.delete(edit_id)
* .then(({ id, object, deleted }) => {
* console.log(id);
* });
* .then(({ id, object, deleted }) => {
* console.log(id)
* })
* - lang: Shell
* label: cURL
* source: |
packages/medusa/src/api/routes/admin/order-edits/get-order-edit.ts
+3 -3
View File
@@ -17,9 +17,9 @@ import { OrderEditService } from "../../../../services"
* const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
* // must be previously logged in or use api token
* medusa.admin.orderEdit.retrieve(orderEditId)
* .then(({ order_edit }) => {
* console.log(order_edit.id);
* });
* .then(({ order_edit }) => {
* console.log(order_edit.id)
* })
* - lang: Shell
* label: cURL
* source: |
packages/medusa/src/api/routes/admin/order-edits/index.ts
+11 -2
View File
@@ -4,7 +4,7 @@ import middlewares, {
transformBody,
transformQuery,
} from "../../../middlewares"
import { DeleteResponse, EmptyQueryParams } from "../../../../types/common"
import { DeleteResponse, FindParams } from "../../../../types/common"
import { isFeatureFlagEnabled } from "../../../middlewares/feature-flag-enabled"
import OrderEditingFeatureFlag from "../../../../loaders/feature-flags/order-editing"
import {
@@ -14,6 +14,7 @@ import {
import { OrderEdit } from "../../../../models"
import { AdminPostOrderEditsOrderEditReq } from "./update-order-edit"
import { AdminPostOrderEditsReq } from "./create-order-edit"
import { AdminPostOrderEditsEditLineItemsLineItemReq } from "./update-order-edit-line-item"
const route = Router()
@@ -32,7 +33,7 @@ export default (app) => {
route.get(
"/:id",
transformQuery(EmptyQueryParams, {
transformQuery(FindParams, {
defaultRelations: defaultOrderEditRelations,
defaultFields: defaultOrderEditFields,
isList: false,
@@ -62,6 +63,13 @@ export default (app) => {
"/:id/request",
middlewares.wrap(require("./request-confirmation").default)
)
route.post(
"/:id/items/:item_id",
transformBody(AdminPostOrderEditsEditLineItemsLineItemReq),
middlewares.wrap(require("./update-order-edit-line-item").default)
)
return app
}
@@ -76,4 +84,5 @@ export type AdminOrderEditItemChangeDeleteRes = {
}
export * from "./update-order-edit"
export * from "./update-order-edit-line-item"
export * from "./create-order-edit"
packages/medusa/src/api/routes/admin/order-edits/update-order-edit-line-item.ts
+94
View File
@@ -0,0 +1,94 @@
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 [post] /order-edits/{id}/items/{item_id}
* operationId: "PostOrderEditsEditLineItemsLineItem"
* summary: "Create or update the order edit change holding the line item changes"
* 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) item_id=* {string} The ID of the order edit item to update.
* 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.updateLineItem(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}'
* -d '{ "quantity": 5 }'
* 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 validatedBody =
req.validatedBody as AdminPostOrderEditsEditLineItemsLineItemReq
const orderEditService: OrderEditService =
req.scope.resolve("orderEditService")
const manager: EntityManager = req.scope.resolve("manager")
await manager.transaction(async (transactionManager) => {
await orderEditService
.withTransaction(transactionManager)
.updateLineItem(id, item_id, validatedBody)
})
let orderEdit = await orderEditService.retrieve(id, {
select: defaultOrderEditFields,
relations: defaultOrderEditRelations,
})
orderEdit = await orderEditService.decorateTotals(orderEdit)
res.status(200).send({
order_edit: orderEdit,
})
}
export class AdminPostOrderEditsEditLineItemsLineItemReq {
@IsNumber()
quantity: number
}
packages/medusa/src/api/routes/admin/order-edits/update-order-edit.ts
+3 -3
View File
@@ -25,9 +25,9 @@ import {
* // must be previously logged in or use api token
* const params = {internal_note: "internal reason XY"}
* medusa.admin.orderEdit.update(orderEditId, params)
* .then(({ order_edit }) => {
* console.log(order_edit.id);
* });
* .then(({ order_edit }) => {
* console.log(order_edit.id)
* })
* - lang: Shell
* label: cURL
* source: |
packages/medusa/src/api/routes/store/order-edits/index.ts
+2 -2
View File
@@ -3,7 +3,7 @@ import middlewares, {
transformBody,
transformQuery,
} from "../../../middlewares"
import { EmptyQueryParams } from "../../../../types/common"
import { FindParams } from "../../../../types/common"
import { isFeatureFlagEnabled } from "../../../middlewares/feature-flag-enabled"
import OrderEditingFeatureFlag from "../../../../loaders/feature-flags/order-editing"
import {
@@ -24,7 +24,7 @@ export default (app) => {
route.get(
"/:id",
transformQuery(EmptyQueryParams, {
transformQuery(FindParams, {
defaultRelations: defaultStoreOrderEditRelations,
defaultFields: defaultStoreOrderEditFields,
allowedFields: defaultStoreOrderEditFields,