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

chore(medusa, core-flows): receive item return request (#8172)

Browse Source 
What:
* `POST /admin/returns/:id/receive-items`
* `POST /admin/returns/:id/receive-items/:action_id`
* `DELETE /admin/returns/:id/receive-items/:action_id`
* `POST /admin/returns/:id/dismiss-items`
* `POST /admin/returns/:id/dismiss-items/:action_id`
* `DELETE /admin/returns/:id/dismiss-items/:action_id`
* `POST /admin/returns/:id/receive/confirm`

CLOSES: CC-190, CC-191, CC-192, CC-193, CC-195, CC-196, CC-197

* Inventory management isn't included yet. Will add it in a next PR
This commit is contained in:
Carlos R. L. Rodrigues
2024-07-18 14:46:34 +00:00
committed by GitHub
parent 8d083d6d0f
commit 535832b692
26 changed files with 1032 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/core/core-flows/src/order/steps/create-return-items.ts
+1 -1
View File
@@ -11,7 +11,7 @@ type CreateReturnItemsInput = {
returnId: string
}
export const createReturnItems = createStep(
export const createReturnItemsStep = createStep(
"create-return-items",
async (input: CreateReturnItemsInput, { container }) => {
const orderModuleService = container.resolve<IOrderModuleService>(
packages/core/core-flows/src/order/steps/index.ts
+1
View File
@@ -26,5 +26,6 @@ export * from "./register-shipment"
export * from "./set-tax-lines-for-items"
export * from "./update-order-change-actions"
export * from "./update-order-exchanges"
export * from "./update-return-items"
export * from "./update-shipping-methods"
export * from "./update-tax-lines"
packages/core/core-flows/src/order/steps/update-return-items.ts
+39
View File
@@ -0,0 +1,39 @@
import {
ModuleRegistrationName,
getSelectsAndRelationsFromObjectArray,
} from "@medusajs/utils"
import { StepResponse, createStep } from "@medusajs/workflows-sdk"
interface UpdateReturnItemBySelector {
id: string
[key: string]: any
}
export const updateReturnItemsStepId = "update-return-items"
export const updateReturnItemsStep = createStep(
updateReturnItemsStepId,
async (data: UpdateReturnItemBySelector[], { container }) => {
const service = container.resolve(ModuleRegistrationName.ORDER) as any
const { selects, relations } = getSelectsAndRelationsFromObjectArray(data, {
objectFields: ["metadata"],
})
const dataBeforeUpdate = await service.listReturnItems(
{ id: data.map((d) => d.id) },
{ relations, select: selects }
)
const updated = await service.updateReturnItems(data)
return new StepResponse(updated, dataBeforeUpdate)
},
async (dataBeforeUpdate, { container }) => {
if (!dataBeforeUpdate?.length) {
return
}
const service = container.resolve(ModuleRegistrationName.ORDER) as any
await service.updateReturnItems(dataBeforeUpdate)
}
)
packages/core/core-flows/src/order/steps/update-shipping-methods.ts
+1 -1
View File
@@ -19,7 +19,7 @@ export const updateOrderShippingMethodsStep = createStep(
const { selects, relations } = getSelectsAndRelationsFromObjectArray(data, {
objectFields: ["metadata"],
})
const dataBeforeUpdate = await service.listOrderClaims(
const dataBeforeUpdate = await service.listShippingMethods(
{ id: data.map((d) => d.id) },
{ relations, select: selects }
)
packages/core/core-flows/src/order/utils/order-validation.ts
+1 -1
View File
@@ -84,7 +84,7 @@ export function throwIfItemsDoesNotExistsInReturn({
orderReturn: Pick<ReturnDTO, "id" | "items">
inputItems: OrderWorkflow.CreateOrderFulfillmentWorkflowInput["items"]
}) {
const orderReturnItemIds = orderReturn.items?.map((i) => i.id) ?? []
const orderReturnItemIds = orderReturn.items?.map((i: any) => i.item_id) ?? []
const inputItemIds = inputItems.map((i) => i.id)
const diff = arrayDifference(inputItemIds, orderReturnItemIds)
packages/core/core-flows/src/order/workflows/index.ts
+5 -1
View File
@@ -25,13 +25,17 @@ export * from "./return/begin-return"
export * from "./return/cancel-receive-return"
export * from "./return/cancel-request-return"
export * from "./return/cancel-return"
export * from "./return/confirm-receive-return-request"
export * from "./return/confirm-return-request"
export * from "./return/create-complete-return"
export * from "./return/create-return-shipping-method"
export * from "./return/dismiss-item-return-request"
export * from "./return/receive-complete-return"
export * from "./return/remove-request-item-return"
export * from "./return/receive-item-return-request"
export * from "./return/remove-item-return-action"
export * from "./return/remove-return-shipping-method"
export * from "./return/request-item-return"
export * from "./return/update-receive-item-return-request"
export * from "./return/update-request-item-return"
export * from "./return/update-return-shipping-method"
export * from "./update-order-change-actions"
packages/core/core-flows/src/order/workflows/return/confirm-receive-return-request.ts
+126
View File
@@ -0,0 +1,126 @@
import {
BigNumberInput,
OrderChangeDTO,
OrderDTO,
ReturnDTO,
} from "@medusajs/types"
import { ChangeActionType, MathBN, OrderChangeStatus } from "@medusajs/utils"
import {
WorkflowData,
createStep,
createWorkflow,
transform,
} from "@medusajs/workflows-sdk"
import { useRemoteQueryStep } from "../../../common"
import { previewOrderChangeStep, updateReturnItemsStep } from "../../steps"
import { confirmOrderChanges } from "../../steps/confirm-order-changes"
import {
throwIfIsCancelled,
throwIfOrderChangeIsNotActive,
} from "../../utils/order-validation"
type WorkflowInput = {
return_id: string
}
const validationStep = createStep(
"validate-confirm-return-receive",
async function ({
order,
orderChange,
orderReturn,
}: {
order: OrderDTO
orderReturn: ReturnDTO
orderChange: OrderChangeDTO
}) {
throwIfIsCancelled(order, "Order")
throwIfIsCancelled(orderReturn, "Return")
throwIfOrderChangeIsNotActive({ orderChange })
}
)
export const confirmReturnReceiveWorkflowId = "confirm-return-receive"
export const confirmReturnReceiveWorkflow = createWorkflow(
confirmReturnReceiveWorkflowId,
function (input: WorkflowInput): WorkflowData<OrderDTO> {
const orderReturn: ReturnDTO = useRemoteQueryStep({
entry_point: "return",
fields: ["id", "status", "order_id", "canceled_at", "items.*"],
variables: { id: input.return_id },
list: false,
throw_if_key_not_found: true,
})
const order: OrderDTO = useRemoteQueryStep({
entry_point: "orders",
fields: ["id", "version", "canceled_at"],
variables: { id: orderReturn.order_id },
list: false,
throw_if_key_not_found: true,
}).config({ name: "order-query" })
const orderChange: OrderChangeDTO = useRemoteQueryStep({
entry_point: "order_change",
fields: [
"id",
"actions.id",
"actions.action",
"actions.details",
"actions.reference",
"actions.reference_id",
"actions.internal_note",
],
variables: {
filters: {
order_id: orderReturn.order_id,
return_id: orderReturn.id,
status: [OrderChangeStatus.PENDING, OrderChangeStatus.REQUESTED],
},
},
list: false,
}).config({ name: "order-change-query" })
const updateReturnItem = transform({ orderChange, orderReturn }, (data) => {
const retItems = data.orderReturn.items!
const received = data.orderChange.actions.filter((act) =>
[
ChangeActionType.RECEIVE_RETURN_ITEM,
ChangeActionType.RECEIVE_DAMAGED_RETURN_ITEM,
].includes(act.action as ChangeActionType)
)
const itemMap = retItems.reduce((acc, item: any) => {
acc[item.item_id] = item.id
return acc
}, {})
const itemUpdates = {}
received.forEach((act) => {
const itemId = act.details!.reference_id as string
if (itemUpdates[itemId]) {
itemUpdates[itemId].received_quantity = MathBN.add(
itemUpdates[itemId].received_quantity,
act.details!.quantity as BigNumberInput
)
return
}
itemUpdates[itemId] = {
id: itemMap[itemId],
received_quantity: act.details!.quantity,
}
})
return Object.values(itemUpdates) as any
})
validationStep({ order, orderReturn, orderChange })
updateReturnItemsStep(updateReturnItem)
confirmOrderChanges({ changes: [orderChange], orderId: order.id })
return previewOrderChangeStep(order.id)
}
)
packages/core/core-flows/src/order/workflows/return/confirm-return-request.ts
+6 -3
View File
@@ -9,7 +9,7 @@ import {
import { useRemoteQueryStep } from "../../../common"
import { previewOrderChangeStep } from "../../steps"
import { confirmOrderChanges } from "../../steps/confirm-order-changes"
import { createReturnItems } from "../../steps/create-return-items"
import { createReturnItemsStep } from "../../steps/create-return-items"
import {
throwIfIsCancelled,
throwIfOrderChangeIsNotActive,
@@ -20,7 +20,7 @@ type WorkflowInput = {
}
const validationStep = createStep(
"validate-create-return-shipping-method",
"validate-confirm-return-request",
async function ({
order,
orderChange,
@@ -85,7 +85,10 @@ export const confirmReturnRequestWorkflow = createWorkflow(
validationStep({ order, orderReturn, orderChange })
createReturnItems({ returnId: orderReturn.id, changes: returnItemActions })
createReturnItemsStep({
returnId: orderReturn.id,
changes: returnItemActions,
})
confirmOrderChanges({ changes: [orderChange], orderId: order.id })
packages/core/core-flows/src/order/workflows/return/dismiss-item-return-request.ts
+107
View File
@@ -0,0 +1,107 @@
import {
OrderChangeDTO,
OrderDTO,
OrderWorkflow,
ReturnDTO,
} from "@medusajs/types"
import { ChangeActionType, OrderChangeStatus } from "@medusajs/utils"
import {
WorkflowData,
createStep,
createWorkflow,
transform,
} from "@medusajs/workflows-sdk"
import { useRemoteQueryStep } from "../../../common"
import { previewOrderChangeStep } from "../../steps"
import { createOrderChangeActionsStep } from "../../steps/create-order-change-actions"
import {
throwIfIsCancelled,
throwIfItemsDoesNotExistsInReturn,
throwIfOrderChangeIsNotActive,
} from "../../utils/order-validation"
const validationStep = createStep(
"dismiss-item-return-request-validation",
async function (
{
order,
orderChange,
orderReturn,
items,
}: {
order: Pick<OrderDTO, "id" | "items">
orderReturn: ReturnDTO
orderChange: OrderChangeDTO
items: OrderWorkflow.ReceiveOrderReturnItemsWorkflowInput["items"]
},
context
) {
throwIfIsCancelled(order, "Order")
throwIfIsCancelled(orderReturn, "Return")
throwIfOrderChangeIsNotActive({ orderChange })
throwIfItemsDoesNotExistsInReturn({ orderReturn, inputItems: items })
}
)
export const dismissItemReturnRequestWorkflowId = "dismiss-item-return-request"
export const dismissItemReturnRequestWorkflow = createWorkflow(
dismissItemReturnRequestWorkflowId,
function (
input: WorkflowData<OrderWorkflow.ReceiveOrderReturnItemsWorkflowInput>
): WorkflowData<OrderDTO> {
const orderReturn: ReturnDTO = useRemoteQueryStep({
entry_point: "return",
fields: ["id", "status", "order_id", "canceled_at", "items.*"],
variables: { id: input.return_id },
list: false,
throw_if_key_not_found: true,
})
const order: OrderDTO = useRemoteQueryStep({
entry_point: "orders",
fields: ["id", "status", "canceled_at"],
variables: { id: orderReturn.order_id },
list: false,
throw_if_key_not_found: true,
}).config({ name: "order-query" })
const orderChange: OrderChangeDTO = useRemoteQueryStep({
entry_point: "order_change",
fields: ["id", "status", "order_id", "return_id"],
variables: {
filters: {
order_id: orderReturn.order_id,
return_id: orderReturn.id,
status: [OrderChangeStatus.PENDING, OrderChangeStatus.REQUESTED],
},
},
list: false,
}).config({ name: "order-change-query" })
validationStep({ order, items: input.items, orderReturn, orderChange })
const orderChangeActionInput = transform(
{ order, orderChange, orderReturn, items: input.items },
({ order, orderChange, orderReturn, items }) => {
return items.map((item) => ({
order_change_id: orderChange.id,
order_id: order.id,
return_id: orderReturn.id,
version: orderChange.version,
action: ChangeActionType.RECEIVE_DAMAGED_RETURN_ITEM,
internal_note: item.internal_note,
reference: "return",
reference_id: orderReturn.id,
details: {
reference_id: item.id,
quantity: item.quantity,
},
}))
}
)
createOrderChangeActionsStep(orderChangeActionInput)
return previewOrderChangeStep(order.id)
}
)
packages/core/core-flows/src/order/workflows/return/receive-item-return-request.ts
+107
View File
@@ -0,0 +1,107 @@
import {
OrderChangeDTO,
OrderDTO,
OrderWorkflow,
ReturnDTO,
} from "@medusajs/types"
import { ChangeActionType, OrderChangeStatus } from "@medusajs/utils"
import {
WorkflowData,
createStep,
createWorkflow,
transform,
} from "@medusajs/workflows-sdk"
import { useRemoteQueryStep } from "../../../common"
import { previewOrderChangeStep } from "../../steps"
import { createOrderChangeActionsStep } from "../../steps/create-order-change-actions"
import {
throwIfIsCancelled,
throwIfItemsDoesNotExistsInReturn,
throwIfOrderChangeIsNotActive,
} from "../../utils/order-validation"
const validationStep = createStep(
"receive-item-return-request-validation",
async function (
{
order,
orderChange,
orderReturn,
items,
}: {
order: Pick<OrderDTO, "id" | "items">
orderReturn: ReturnDTO
orderChange: OrderChangeDTO
items: OrderWorkflow.ReceiveOrderReturnItemsWorkflowInput["items"]
},
context
) {
throwIfIsCancelled(order, "Order")
throwIfIsCancelled(orderReturn, "Return")
throwIfOrderChangeIsNotActive({ orderChange })
throwIfItemsDoesNotExistsInReturn({ orderReturn, inputItems: items })
}
)
export const receiveItemReturnRequestWorkflowId = "receive-item-return-request"
export const receiveItemReturnRequestWorkflow = createWorkflow(
receiveItemReturnRequestWorkflowId,
function (
input: WorkflowData<OrderWorkflow.ReceiveOrderReturnItemsWorkflowInput>
): WorkflowData<OrderDTO> {
const orderReturn: ReturnDTO = useRemoteQueryStep({
entry_point: "return",
fields: ["id", "status", "order_id", "canceled_at", "items.*"],
variables: { id: input.return_id },
list: false,
throw_if_key_not_found: true,
})
const order: OrderDTO = useRemoteQueryStep({
entry_point: "orders",
fields: ["id", "status", "canceled_at"],
variables: { id: orderReturn.order_id },
list: false,
throw_if_key_not_found: true,
}).config({ name: "order-query" })
const orderChange: OrderChangeDTO = useRemoteQueryStep({
entry_point: "order_change",
fields: ["id", "status", "order_id", "return_id"],
variables: {
filters: {
order_id: orderReturn.order_id,
return_id: orderReturn.id,
status: [OrderChangeStatus.PENDING, OrderChangeStatus.REQUESTED],
},
},
list: false,
}).config({ name: "order-change-query" })
validationStep({ order, items: input.items, orderReturn, orderChange })
const orderChangeActionInput = transform(
{ order, orderChange, orderReturn, items: input.items },
({ order, orderChange, orderReturn, items }) => {
return items.map((item) => ({
order_change_id: orderChange.id,
order_id: order.id,
return_id: orderReturn.id,
version: orderChange.version,
action: ChangeActionType.RECEIVE_RETURN_ITEM,
internal_note: item.internal_note,
reference: "return",
reference_id: orderReturn.id,
details: {
reference_id: item.id,
quantity: item.quantity,
},
}))
}
)
createOrderChangeActionsStep(orderChangeActionInput)
return previewOrderChangeStep(order.id)
}
)
packages/core/core-flows/src/order/workflows/return/remove-request-item-return.ts → packages/core/core-flows/src/order/workflows/return/remove-item-return-action.ts
+4 -4
View File
@@ -22,7 +22,7 @@ import {
} from "../../utils/order-validation"
const validationStep = createStep(
"remove-request-item-return-validation",
"remove-item-return-action-validation",
async function ({
order,
orderChange,
@@ -54,9 +54,9 @@ const validationStep = createStep(
}
)
export const removeRequestItemReturnWorkflowId = "remove-request-item-return"
export const removeRequestItemReturnWorkflow = createWorkflow(
removeRequestItemReturnWorkflowId,
export const removeItemReturnActionWorkflowId = "remove-item-return-action"
export const removeItemReturnActionWorkflow = createWorkflow(
removeItemReturnActionWorkflowId,
function (
input: WorkflowData<OrderWorkflow.DeleteRequestItemReturnWorkflowInput>
): WorkflowData<OrderDTO> {
packages/core/core-flows/src/order/workflows/return/update-receive-item-return-request.ts
+126
View File
@@ -0,0 +1,126 @@
import {
OrderChangeActionDTO,
OrderChangeDTO,
OrderDTO,
OrderWorkflow,
ReturnDTO,
} from "@medusajs/types"
import { ChangeActionType, OrderChangeStatus } from "@medusajs/utils"
import {
WorkflowData,
createStep,
createWorkflow,
transform,
} from "@medusajs/workflows-sdk"
import { useRemoteQueryStep } from "../../../common"
import {
previewOrderChangeStep,
updateOrderChangeActionsStep,
} from "../../steps"
import {
throwIfIsCancelled,
throwIfOrderChangeIsNotActive,
} from "../../utils/order-validation"
const validationStep = createStep(
"update-receive-item-return-request-validation",
async function (
{
order,
orderChange,
orderReturn,
input,
}: {
order: OrderDTO
orderReturn: ReturnDTO
orderChange: OrderChangeDTO
input: OrderWorkflow.UpdateReceiveItemReturnRequestWorkflowInput
},
context
) {
throwIfIsCancelled(order, "Order")
throwIfIsCancelled(orderReturn, "Return")
throwIfOrderChangeIsNotActive({ orderChange })
const associatedAction = (orderChange.actions ?? []).find(
(a) => a.id === input.action_id
) as OrderChangeActionDTO
if (!associatedAction) {
throw new Error(
`No request return found for return ${input.return_id} in order change ${orderChange.id}`
)
} else if (
[
ChangeActionType.RECEIVE_RETURN_ITEM,
ChangeActionType.RECEIVE_DAMAGED_RETURN_ITEM,
].includes(associatedAction.action as ChangeActionType)
) {
throw new Error(
`Action ${associatedAction.id} is not receiving an item return request`
)
}
}
)
export const updateReceiveItemReturnRequestWorkflowId =
"update-receive-item-return-request"
export const updateReceiveItemReturnRequestWorkflow = createWorkflow(
updateReceiveItemReturnRequestWorkflowId,
function (
input: WorkflowData<OrderWorkflow.UpdateReceiveItemReturnRequestWorkflowInput>
): WorkflowData<OrderDTO> {
const orderReturn: ReturnDTO = useRemoteQueryStep({
entry_point: "return",
fields: ["id", "status", "order_id", "canceled_at"],
variables: { id: input.return_id },
list: false,
throw_if_key_not_found: true,
})
const order: OrderDTO = useRemoteQueryStep({
entry_point: "orders",
fields: ["id", "status", "canceled_at", "items.*"],
variables: { id: orderReturn.order_id },
list: false,
throw_if_key_not_found: true,
}).config({ name: "order-query" })
const orderChange: OrderChangeDTO = useRemoteQueryStep({
entry_point: "order_change",
fields: ["id", "status", "version", "actions.*"],
variables: {
filters: {
order_id: orderReturn.order_id,
return_id: orderReturn.id,
status: [OrderChangeStatus.PENDING, OrderChangeStatus.REQUESTED],
},
},
list: false,
}).config({ name: "order-change-query" })
validationStep({ order, input, orderReturn, orderChange })
const updateData = transform(
{ orderChange, input },
({ input, orderChange }) => {
const originalAction = (orderChange.actions ?? []).find(
(a) => a.id === input.action_id
) as OrderChangeActionDTO
const data = input.data
return {
id: input.action_id,
details: {
quantity: data.quantity ?? originalAction.details?.quantity,
},
internal_note: data.internal_note,
}
}
)
updateOrderChangeActionsStep([updateData])
return previewOrderChangeStep(order.id)
}
)