chore(core-flows, medusa): cancel request return (#8153)

* fix(core-flow): request item return reason

* chore(core-flows): cancel request return
This commit is contained in:
Carlos R. L. Rodrigues
2024-07-17 09:35:46 +01:00
committed by GitHub
parent d4fe2daa57
commit 1acfdc4ffe
23 changed files with 263 additions and 28 deletions
@@ -0,0 +1,28 @@
import { IOrderModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/utils"
import { createStep, StepResponse } from "@medusajs/workflows-sdk"
export const deleteReturnsStepId = "delete-return"
export const deleteReturnsStep = createStep(
deleteReturnsStepId,
async (data: { ids: string[] }, { container }) => {
const service = container.resolve<IOrderModuleService>(
ModuleRegistrationName.ORDER
)
const deleted = await service.softDeleteReturns(data.ids)
return new StepResponse(deleted, data.ids)
},
async (ids, { container }) => {
if (!ids) {
return
}
const service = container.resolve<IOrderModuleService>(
ModuleRegistrationName.ORDER
)
await service.restoreReturns(ids)
}
)
@@ -18,6 +18,7 @@ export * from "./delete-line-items"
export * from "./delete-order-change-actions"
export * from "./delete-order-changes"
export * from "./delete-order-shipping-methods"
export * from "./delete-return"
export * from "./get-item-tax-lines"
export * from "./preview-order-change"
export * from "./register-fulfillment"
@@ -4,7 +4,7 @@ import {
OrderDTO,
OrderWorkflow,
} from "@medusajs/types"
import { ChangeActionType } from "@medusajs/utils"
import { ChangeActionType, OrderChangeStatus } from "@medusajs/utils"
import {
WorkflowData,
createStep,
@@ -63,7 +63,13 @@ export const orderClaimAddNewItemWorkflow = createWorkflow(
const orderChange: OrderChangeDTO = useRemoteQueryStep({
entry_point: "order_change",
fields: ["id", "status"],
variables: { order_id: orderClaim.order_id },
variables: {
filters: {
order_id: orderClaim.order_id,
claim_id: orderClaim.id,
status: [OrderChangeStatus.PENDING, OrderChangeStatus.REQUESTED],
},
},
list: false,
}).config({ name: "order-change-query" })
@@ -5,7 +5,7 @@ import {
OrderWorkflow,
ReturnDTO,
} from "@medusajs/types"
import { ChangeActionType } from "@medusajs/utils"
import { ChangeActionType, OrderChangeStatus } from "@medusajs/utils"
import {
WorkflowData,
createStep,
@@ -103,9 +103,18 @@ export const orderClaimRequestItemReturnWorkflow = createWorkflow(
const orderChange: OrderChangeDTO = useRemoteQueryStep({
entry_point: "order_change",
fields: ["id", "status"],
variables: { order_id: orderClaim.order_id },
variables: {
filters: {
order_id: orderClaim.order_id,
claim_id: orderClaim.id,
status: [OrderChangeStatus.PENDING, OrderChangeStatus.REQUESTED],
},
},
list: false,
}).config({ name: "order-change-query" })
}).config({
name: "order-change-query",
status: [OrderChangeStatus.PENDING, OrderChangeStatus.REQUESTED],
})
validationStep({
order,
@@ -4,7 +4,7 @@ import {
OrderDTO,
OrderExchangeDTO,
} from "@medusajs/types"
import { ChangeActionType } from "@medusajs/utils"
import { ChangeActionType, OrderChangeStatus } from "@medusajs/utils"
import {
WorkflowData,
createStep,
@@ -102,7 +102,13 @@ export const createExchangeReturnShippingMethodWorkflow = createWorkflow(
const orderChange: OrderChangeDTO = useRemoteQueryStep({
entry_point: "order_change",
fields: ["id", "status"],
variables: { order_id: orderExchange.order_id },
variables: {
filters: {
order_id: orderExchange.order_id,
exchange_id: orderExchange.id,
status: [OrderChangeStatus.PENDING, OrderChangeStatus.REQUESTED],
},
},
list: false,
}).config({ name: "order-change-query" })
@@ -4,7 +4,7 @@ import {
OrderExchangeDTO,
OrderWorkflow,
} from "@medusajs/types"
import { ChangeActionType } from "@medusajs/utils"
import { ChangeActionType, OrderChangeStatus } from "@medusajs/utils"
import {
WorkflowData,
createStep,
@@ -63,7 +63,13 @@ export const orderExchangeAddNewItemWorkflow = createWorkflow(
const orderChange: OrderChangeDTO = useRemoteQueryStep({
entry_point: "order_change",
fields: ["id", "status"],
variables: { order_id: orderExchange.order_id },
variables: {
filters: {
order_id: orderExchange.order_id,
exchange_id: orderExchange.id,
status: [OrderChangeStatus.PENDING, OrderChangeStatus.REQUESTED],
},
},
list: false,
}).config({ name: "order-change-query" })
@@ -5,7 +5,7 @@ import {
OrderWorkflow,
ReturnDTO,
} from "@medusajs/types"
import { ChangeActionType } from "@medusajs/utils"
import { ChangeActionType, OrderChangeStatus } from "@medusajs/utils"
import {
WorkflowData,
createStep,
@@ -104,7 +104,13 @@ export const orderExchangeRequestItemReturnWorkflow = createWorkflow(
const orderChange: OrderChangeDTO = useRemoteQueryStep({
entry_point: "order_change",
fields: ["id", "status"],
variables: { order_id: orderExchange.order_id },
variables: {
filters: {
order_id: orderExchange.order_id,
exchange_id: orderExchange.id,
status: [OrderChangeStatus.PENDING, OrderChangeStatus.REQUESTED],
},
},
list: false,
}).config({ name: "order-change-query" })
@@ -22,6 +22,7 @@ export * from "./exchange/exchange-request-item-return"
export * from "./get-order-detail"
export * from "./get-orders-list"
export * from "./return/begin-return"
export * from "./return/cancel-request-return"
export * from "./return/cancel-return"
export * from "./return/confirm-return-request"
export * from "./return/create-return-shipping-method"
@@ -0,0 +1,92 @@
import { OrderChangeDTO, OrderDTO, ReturnDTO } from "@medusajs/types"
import { ChangeActionType, OrderChangeStatus } from "@medusajs/utils"
import {
WorkflowData,
createStep,
createWorkflow,
parallelize,
transform,
} from "@medusajs/workflows-sdk"
import { useRemoteQueryStep } from "../../../common"
import {
deleteOrderChangesStep,
deleteOrderShippingMethods,
deleteReturnsStep,
} from "../../steps"
import {
throwIfIsCancelled,
throwIfOrderChangeIsNotActive,
} from "../../utils/order-validation"
type WorkflowInput = {
return_id: string
}
const validationStep = createStep(
"validate-cancel-return-shipping-method",
async function ({
order,
orderChange,
orderReturn,
}: {
order: OrderDTO
orderReturn: ReturnDTO
orderChange: OrderChangeDTO
}) {
throwIfIsCancelled(order, "Order")
throwIfIsCancelled(orderReturn, "Return")
throwIfOrderChangeIsNotActive({ orderChange })
}
)
export const cancelReturnRequestWorkflowId = "cancel-return-request"
export const cancelReturnRequestWorkflow = createWorkflow(
cancelReturnRequestWorkflowId,
function (input: WorkflowInput): WorkflowData<void> {
const orderReturn: ReturnDTO = useRemoteQueryStep({
entry_point: "return",
fields: ["id", "status", "order_id"],
variables: { id: input.return_id },
list: false,
throw_if_key_not_found: true,
})
const order: OrderDTO = useRemoteQueryStep({
entry_point: "orders",
fields: ["id", "version", "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, orderReturn, orderChange })
const shippingToRemove = transform(
{ orderChange, input },
({ orderChange, input }) => {
return (orderChange.actions ?? [])
.filter((a) => a.action === ChangeActionType.SHIPPING_ADD)
.map(({ id }) => id)
}
)
parallelize(
deleteReturnsStep({ ids: [orderReturn.id] }),
deleteOrderChangesStep({ ids: [orderChange.id] }),
deleteOrderShippingMethods({ ids: shippingToRemove })
)
}
)
@@ -1,5 +1,5 @@
import { OrderChangeDTO, OrderDTO, ReturnDTO } from "@medusajs/types"
import { ChangeActionType } from "@medusajs/utils"
import { ChangeActionType, OrderChangeStatus } from "@medusajs/utils"
import {
WorkflowData,
createStep,
@@ -71,6 +71,7 @@ export const confirmReturnRequestWorkflow = createWorkflow(
filters: {
order_id: orderReturn.order_id,
return_id: orderReturn.id,
status: [OrderChangeStatus.PENDING, OrderChangeStatus.REQUESTED],
},
},
list: false,
@@ -84,6 +84,7 @@ export const createReturnShippingMethodWorkflow = createWorkflow(
variables: {
filters: {
order_id: orderReturn.order_id,
return_id: orderReturn.id,
status: [OrderChangeStatus.PENDING, OrderChangeStatus.REQUESTED],
},
},
@@ -4,7 +4,7 @@ import {
OrderWorkflow,
ReturnDTO,
} from "@medusajs/types"
import { ChangeActionType } from "@medusajs/utils"
import { ChangeActionType, OrderChangeStatus } from "@medusajs/utils"
import {
WorkflowData,
createStep,
@@ -75,7 +75,11 @@ export const requestItemReturnWorkflow = createWorkflow(
entry_point: "order_change",
fields: ["id", "status", "order_id", "return_id"],
variables: {
filters: { order_id: orderReturn.order_id, return_id: orderReturn.id },
filters: {
order_id: orderReturn.order_id,
return_id: orderReturn.id,
status: [OrderChangeStatus.PENDING, OrderChangeStatus.REQUESTED],
},
},
list: false,
}).config({ name: "order-change-query" })