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

feat(core-flows): begin returns, claims and exchanges (#8088)

Browse Source 
* chore(order): begin return

* claims and exchanges
This commit is contained in:
Carlos R. L. Rodrigues
2024-07-11 09:53:00 -03:00
committed by GitHub
parent 368715ae37
commit b5c658f071
25 changed files with 1865 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/core/core-flows/src/order/steps/create-claims.ts
+32
View File
@@ -0,0 +1,32 @@
import { CreateOrderClaimDTO, IOrderModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/utils"
import { StepResponse, createStep } from "@medusajs/workflows-sdk"
type CreateOrderClaimsStepInput = CreateOrderClaimDTO[]
export const createOrderClaimsStepId = "create-order-claims"
export const createOrderClaimsStep = createStep(
createOrderClaimsStepId,
async (data: CreateOrderClaimsStepInput, { container }) => {
const service = container.resolve<IOrderModuleService>(
ModuleRegistrationName.ORDER
)
const orderClaims = await service.createOrderClaims(data)
const claimIds = orderClaims.map((claim) => claim.id)
return new StepResponse(orderClaims, claimIds)
},
async (claimIds, { container }) => {
if (!claimIds) {
return
}
const service = container.resolve<IOrderModuleService>(
ModuleRegistrationName.ORDER
)
await service.deleteOrderClaims(claimIds)
}
)
packages/core/core-flows/src/order/steps/create-return.ts → packages/core/core-flows/src/order/steps/create-complete-return.ts
+5 -5
View File
@@ -2,12 +2,12 @@ import { CreateOrderReturnDTO, IOrderModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/utils"
import { StepResponse, createStep } from "@medusajs/workflows-sdk"
type CreateReturnStepInput = CreateOrderReturnDTO
type CreateCompleteReturnStepInput = CreateOrderReturnDTO
export const createReturnStepId = "create-return"
export const createReturnStep = createStep(
createReturnStepId,
async (data: CreateReturnStepInput, { container }) => {
export const createCompleteReturnStepId = "create-complete-return"
export const createCompleteReturnStep = createStep(
createCompleteReturnStepId,
async (data: CreateCompleteReturnStepInput, { container }) => {
const service = container.resolve<IOrderModuleService>(
ModuleRegistrationName.ORDER
)
packages/core/core-flows/src/order/steps/create-exchanges.ts
+32
View File
@@ -0,0 +1,32 @@
import { CreateOrderExchangeDTO, IOrderModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/utils"
import { StepResponse, createStep } from "@medusajs/workflows-sdk"
type CreateOrderExchangesStepInput = CreateOrderExchangeDTO[]
export const createOrderExchangesStepId = "create-order-exchanges"
export const createOrderExchangesStep = createStep(
createOrderExchangesStepId,
async (data: CreateOrderExchangesStepInput, { container }) => {
const service = container.resolve<IOrderModuleService>(
ModuleRegistrationName.ORDER
)
const orderExchanges = await service.createOrderExchanges(data)
const exchangeIds = orderExchanges.map((exchange) => exchange.id)
return new StepResponse(orderExchanges, exchangeIds)
},
async (exchangeIds, { container }) => {
if (!exchangeIds) {
return
}
const service = container.resolve<IOrderModuleService>(
ModuleRegistrationName.ORDER
)
await service.deleteOrderExchanges(exchangeIds)
}
)
packages/core/core-flows/src/order/steps/create-returns.ts
+32
View File
@@ -0,0 +1,32 @@
import { CreateOrderReturnDTO, IOrderModuleService } from "@medusajs/types"
import { ModuleRegistrationName } from "@medusajs/utils"
import { StepResponse, createStep } from "@medusajs/workflows-sdk"
type CreateReturnsStepInput = CreateOrderReturnDTO[]
export const createReturnsStepId = "create-returns"
export const createReturnsStep = createStep(
createReturnsStepId,
async (data: CreateReturnsStepInput, { container }) => {
const service = container.resolve<IOrderModuleService>(
ModuleRegistrationName.ORDER
)
const orderReturns = await service.createReturns(data)
const returnIds = orderReturns.map((ret) => ret.id)
return new StepResponse(orderReturns, returnIds)
},
async (returnIds, { container }) => {
if (!returnIds) {
return
}
const service = container.resolve<IOrderModuleService>(
ModuleRegistrationName.ORDER
)
await service.deleteReturns(returnIds)
}
)
packages/core/core-flows/src/order/steps/index.ts
+4
View File
@@ -5,9 +5,13 @@ export * from "./cancel-order-change"
export * from "./cancel-orders"
export * from "./cancel-return"
export * from "./complete-orders"
export * from "./create-claims"
export * from "./create-complete-return"
export * from "./create-exchanges"
export * from "./create-order-change"
export * from "./create-order-change-actions"
export * from "./create-orders"
export * from "./create-returns"
export * from "./decline-order-change"
export * from "./delete-order-change"
export * from "./delete-order-change-actions"
packages/core/core-flows/src/order/utils/order-validation.ts
+1 -1
View File
@@ -18,7 +18,7 @@ export function throwIfItemsDoesNotExistsInOrder({
inputItems: OrderWorkflow.CreateOrderFulfillmentWorkflowInput["items"]
}) {
const orderItemIds = order.items?.map((i) => i.id) ?? []
const inputItemIds = inputItems.map((i) => i.id)
const inputItemIds = inputItems?.map((i) => i.id)
const diff = arrayDifference(inputItemIds, orderItemIds)
if (diff.length) {
packages/core/core-flows/src/order/workflows/begin-order-claim.ts
+59
View File
@@ -0,0 +1,59 @@
import { OrderChangeDTO, OrderDTO, OrderWorkflow } from "@medusajs/types"
import {
WorkflowData,
createStep,
createWorkflow,
transform,
} from "@medusajs/workflows-sdk"
import { useRemoteQueryStep } from "../../common"
import { createOrderClaimsStep } from "../steps/create-claims"
import { createOrderChangeStep } from "../steps/create-order-change"
import { throwIfOrderIsCancelled } from "../utils/order-validation"
const validationStep = createStep(
"begin-claim-order-validation",
async function ({ order }: { order: OrderDTO }) {
throwIfOrderIsCancelled({ order })
}
)
export const beginClaimOrderWorkflowId = "begin-claim-order"
export const beginClaimOrderWorkflow = createWorkflow(
beginClaimOrderWorkflowId,
function (
input: WorkflowData<OrderWorkflow.beginOrderClaimWorkflowInput>
): WorkflowData<OrderChangeDTO> {
const order: OrderDTO = useRemoteQueryStep({
entry_point: "orders",
fields: ["id", "status"],
variables: { id: input.order_id },
list: false,
throw_if_key_not_found: true,
})
validationStep({ order })
const created = createOrderClaimsStep([
{
type: input.type,
order_id: input.order_id,
metadata: input.metadata,
},
])
const orderChangeInput = transform(
{ created, input },
({ created, input }) => {
return {
change_type: "claim" as const,
order_id: input.order_id,
claim_id: created[0].id,
created_by: input.created_by,
description: input.description,
internal_note: input.internal_note,
}
}
)
return createOrderChangeStep(orderChangeInput)
}
)
packages/core/core-flows/src/order/workflows/begin-order-exchange.ts
+58
View File
@@ -0,0 +1,58 @@
import { OrderChangeDTO, OrderDTO, OrderWorkflow } from "@medusajs/types"
import {
WorkflowData,
createStep,
createWorkflow,
transform,
} from "@medusajs/workflows-sdk"
import { useRemoteQueryStep } from "../../common"
import { createOrderExchangesStep } from "../steps/create-exchanges"
import { createOrderChangeStep } from "../steps/create-order-change"
import { throwIfOrderIsCancelled } from "../utils/order-validation"
const validationStep = createStep(
"begin-exchange-order-validation",
async function ({ order }: { order: OrderDTO }) {
throwIfOrderIsCancelled({ order })
}
)
export const beginExchangeOrderWorkflowId = "begin-exchange-order"
export const beginExchangeOrderWorkflow = createWorkflow(
beginExchangeOrderWorkflowId,
function (
input: WorkflowData<OrderWorkflow.beginOrderExchangeWorkflowInput>
): WorkflowData<OrderChangeDTO> {
const order: OrderDTO = useRemoteQueryStep({
entry_point: "orders",
fields: ["id", "status"],
variables: { id: input.order_id },
list: false,
throw_if_key_not_found: true,
})
validationStep({ order })
const created = createOrderExchangesStep([
{
order_id: input.order_id,
metadata: input.metadata,
},
])
const orderChangeInput = transform(
{ created, input },
({ created, input }) => {
return {
change_type: "exchange" as const,
order_id: input.order_id,
exchange_id: created[0].id,
created_by: input.created_by,
description: input.description,
internal_note: input.internal_note,
}
}
)
return createOrderChangeStep(orderChangeInput)
}
)
packages/core/core-flows/src/order/workflows/begin-return.ts
+58
View File
@@ -0,0 +1,58 @@
import { OrderChangeDTO, OrderDTO, OrderWorkflow } from "@medusajs/types"
import {
WorkflowData,
createStep,
createWorkflow,
transform,
} from "@medusajs/workflows-sdk"
import { useRemoteQueryStep } from "../../common"
import { createOrderChangeStep } from "../steps/create-order-change"
import { createReturnsStep } from "../steps/create-returns"
import { throwIfOrderIsCancelled } from "../utils/order-validation"
const validationStep = createStep(
"begin-return-order-validation",
async function ({ order }: { order: OrderDTO }) {
throwIfOrderIsCancelled({ order })
}
)
export const beginReturnOrderWorkflowId = "begin-return-order"
export const beginReturnOrderWorkflow = createWorkflow(
beginReturnOrderWorkflowId,
function (
input: WorkflowData<OrderWorkflow.beginOrderReturnWorkflowInput>
): WorkflowData<OrderChangeDTO> {
const order: OrderDTO = useRemoteQueryStep({
entry_point: "orders",
fields: ["id", "status"],
variables: { id: input.order_id },
list: false,
throw_if_key_not_found: true,
})
validationStep({ order })
const created = createReturnsStep([
{
order_id: input.order_id,
metadata: input.metadata,
},
])
const orderChangeInput = transform(
{ created, input },
({ created, input }) => {
return {
change_type: "return" as const,
order_id: input.order_id,
return_id: created[0].id,
created_by: input.created_by,
description: input.description,
internal_note: input.internal_note,
}
}
)
return createOrderChangeStep(orderChangeInput)
}
)
packages/core/core-flows/src/order/workflows/create-complete-return.ts
+9 -2
View File
@@ -25,7 +25,7 @@ import {
} from "@medusajs/workflows-sdk"
import { createRemoteLinkStep, useRemoteQueryStep } from "../../common"
import { createReturnFulfillmentWorkflow } from "../../fulfillment"
import { createReturnStep } from "../steps/create-return"
import { createCompleteReturnStep } from "../steps/create-complete-return"
import { receiveReturnStep } from "../steps/receive-return"
import {
throwIfItemsDoesNotExistsInOrder,
@@ -273,6 +273,13 @@ const validationStep = createStep(
},
context
) {
if (!input.items) {
throw new MedusaError(
MedusaError.Types.INVALID_DATA,
`Items are required to create a return.`
)
}
throwIfOrderIsCancelled({ order })
throwIfItemsDoesNotExistsInOrder({ order, inputItems: input.items })
await validateReturnReasons(
@@ -359,7 +366,7 @@ export const createAndCompleteReturnOrderWorkflow = createWorkflow(
)
const [returnCreated] = parallelize(
createReturnStep({
createCompleteReturnStep({
order_id: input.order_id,
items: input.items,
shipping_method: shippingMethodData,
packages/core/core-flows/src/order/workflows/index.ts
+3
View File
@@ -1,4 +1,7 @@
export * from "./archive-orders"
export * from "./begin-order-claim"
export * from "./begin-order-exchange"
export * from "./begin-return"
export * from "./cancel-order"
export * from "./cancel-order-change"
export * from "./cancel-order-fulfillment"