chore(medusa,core-flows): begin and cancel receive return (#8171)

What: * `POST /admin/returns/:id/receive` * `DELETE /admin/returns/:id/receive` CLOSES: CC-189
2024-07-18 09:55:04 -03:00
parent 8ffcec3fc4
commit 1a472733ae
29 changed files with 371 additions and 72 deletions
--- a/packages/core/core-flows/src/order/workflows/claim/claim-add-new-item.ts
+++ b/packages/core/core-flows/src/order/workflows/claim/claim-add-new-item.ts
@@ -46,7 +46,7 @@ export const orderClaimAddNewItemWorkflow = createWorkflow(
  ): WorkflowData<OrderDTO> {
    const orderClaim = useRemoteQueryStep({
      entry_point: "order_claim",
-      fields: ["id", "order_id"],
+      fields: ["id", "order_id", "canceled_at"],
      variables: { id: input.claim_id },
      list: false,
      throw_if_key_not_found: true,
@@ -54,7 +54,7 @@ export const orderClaimAddNewItemWorkflow = createWorkflow(

    const order: OrderDTO = useRemoteQueryStep({
      entry_point: "orders",
-      fields: ["id", "status", "items.*"],
+      fields: ["id", "status", "canceled_at", "items.*"],
      variables: { id: orderClaim.order_id },
      list: false,
      throw_if_key_not_found: true,
--- a/packages/core/core-flows/src/order/workflows/claim/claim-request-item-return.ts
+++ b/packages/core/core-flows/src/order/workflows/claim/claim-request-item-return.ts
@@ -56,7 +56,7 @@ export const orderClaimRequestItemReturnWorkflow = createWorkflow(
  ): WorkflowData<OrderDTO> {
    const orderClaim = useRemoteQueryStep({
      entry_point: "order_claim",
-      fields: ["id", "order_id", "return_id"],
+      fields: ["id", "order_id", "return_id", "canceled_at"],
      variables: { id: input.claim_id },
      list: false,
      throw_if_key_not_found: true,
@@ -67,7 +67,7 @@ export const orderClaimRequestItemReturnWorkflow = createWorkflow(
    }).then(() => {
      return useRemoteQueryStep({
        entry_point: "return",
-        fields: ["id", "status", "order_id"],
+        fields: ["id", "status", "order_id", "canceled_at"],
        variables: { id: orderClaim.return_id },
        list: false,
        throw_if_key_not_found: true,
--- a/packages/core/core-flows/src/order/workflows/exchange/exchange-add-new-item.ts
+++ b/packages/core/core-flows/src/order/workflows/exchange/exchange-add-new-item.ts
@@ -46,7 +46,7 @@ export const orderExchangeAddNewItemWorkflow = createWorkflow(
  ): WorkflowData<OrderDTO> {
    const orderExchange = useRemoteQueryStep({
      entry_point: "order_exchange",
-      fields: ["id", "order_id"],
+      fields: ["id", "order_id", "canceled_at"],
      variables: { id: input.exchange_id },
      list: false,
      throw_if_key_not_found: true,
@@ -54,7 +54,7 @@ export const orderExchangeAddNewItemWorkflow = createWorkflow(

    const order: OrderDTO = useRemoteQueryStep({
      entry_point: "orders",
-      fields: ["id", "status", "items.*"],
+      fields: ["id", "status", "canceled_at", "items.*"],
      variables: { id: orderExchange.order_id },
      list: false,
      throw_if_key_not_found: true,
--- a/packages/core/core-flows/src/order/workflows/exchange/exchange-request-item-return.ts
+++ b/packages/core/core-flows/src/order/workflows/exchange/exchange-request-item-return.ts
@@ -57,7 +57,7 @@ export const orderExchangeRequestItemReturnWorkflow = createWorkflow(
  ): WorkflowData<OrderDTO> {
    const orderExchange = useRemoteQueryStep({
      entry_point: "order_exchange",
-      fields: ["id", "order_id", "return_id"],
+      fields: ["id", "order_id", "return_id", "canceled_at"],
      variables: { id: input.exchange_id },
      list: false,
      throw_if_key_not_found: true,
@@ -68,7 +68,7 @@ export const orderExchangeRequestItemReturnWorkflow = createWorkflow(
    }).then(() => {
      return useRemoteQueryStep({
        entry_point: "return",
-        fields: ["id", "status", "order_id"],
+        fields: ["id", "status", "order_id", "canceled_at"],
        variables: { id: orderExchange.return_id },
        list: false,
        throw_if_key_not_found: true,
--- a/packages/core/core-flows/src/order/workflows/index.ts
+++ b/packages/core/core-flows/src/order/workflows/index.ts
@@ -6,7 +6,6 @@ export * from "./cancel-order-fulfillment"
 export * from "./claim/begin-order-claim"
 export * from "./claim/claim-request-item-return"
 export * from "./complete-orders"
-export * from "./create-complete-return"
 export * from "./create-fulfillment"
 export * from "./create-order-change"
 export * from "./create-order-change-actions"
@@ -21,12 +20,15 @@ export * from "./exchange/exchange-add-new-item"
 export * from "./exchange/exchange-request-item-return"
 export * from "./get-order-detail"
 export * from "./get-orders-list"
+export * from "./return/begin-receive-return"
 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-return-request"
+export * from "./return/create-complete-return"
 export * from "./return/create-return-shipping-method"
-export * from "./return/receive-return"
+export * from "./return/receive-complete-return"
 export * from "./return/remove-request-item-return"
 export * from "./return/remove-return-shipping-method"
 export * from "./return/request-item-return"
--- a/packages/core/core-flows/src/order/workflows/return/begin-receive-return.ts
+++ b/packages/core/core-flows/src/order/workflows/return/begin-receive-return.ts
@@ -0,0 +1,73 @@
+import {
+  OrderChangeDTO,
+  OrderDTO,
+  OrderWorkflow,
+  ReturnDTO,
+} from "@medusajs/types"
+import {
+  WorkflowData,
+  createStep,
+  createWorkflow,
+  transform,
+} from "@medusajs/workflows-sdk"
+import { useRemoteQueryStep } from "../../../common"
+import { createOrderChangeStep } from "../../steps"
+import { throwIfIsCancelled } from "../../utils/order-validation"
+
+const validationStep = createStep(
+  "begin-receive-return-validation",
+  async function (
+    {
+      orderReturn,
+      order,
+    }: {
+      orderReturn: ReturnDTO
+      order: OrderDTO
+    },
+    context
+  ) {
+    throwIfIsCancelled(order, "Order")
+    throwIfIsCancelled(orderReturn, "Return")
+  }
+)
+
+export const beginReceiveReturnWorkflowId = "begin-receive-return"
+export const beginReceiveReturnWorkflow = createWorkflow(
+  beginReceiveReturnWorkflowId,
+  function (
+    input: WorkflowData<OrderWorkflow.BeginReceiveOrderReturnWorkflowInput>
+  ): WorkflowData<OrderChangeDTO> {
+    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", "version", "status", "canceled_at"],
+      variables: { id: orderReturn.order_id },
+      list: false,
+      throw_if_key_not_found: true,
+    }).config({ name: "order-query" })
+
+    validationStep({ order, orderReturn })
+
+    const orderChangeInput = transform(
+      { orderReturn, order, input },
+      ({ orderReturn, order, input }) => {
+        return {
+          change_type: "return" as const,
+          order_id: order.id,
+          return_id: orderReturn.id,
+          created_by: input.created_by,
+          description: input.description,
+          internal_note: input.internal_note,
+        }
+      }
+    )
+    return createOrderChangeStep(orderChangeInput)
+  }
+)
--- a/packages/core/core-flows/src/order/workflows/return/begin-return.ts
+++ b/packages/core/core-flows/src/order/workflows/return/begin-return.ts
@@ -6,8 +6,7 @@ import {
  transform,
 } from "@medusajs/workflows-sdk"
 import { useRemoteQueryStep } from "../../../common"
-import { createOrderChangeStep } from "../../steps/create-order-change"
-import { createReturnsStep } from "../../steps/create-returns"
+import { createOrderChangeStep, createReturnsStep } from "../../steps"
 import { throwIfOrderIsCancelled } from "../../utils/order-validation"

 const validationStep = createStep(
--- a/packages/core/core-flows/src/order/workflows/return/cancel-receive-return.ts
+++ b/packages/core/core-flows/src/order/workflows/return/cancel-receive-return.ts
@@ -0,0 +1,69 @@
+import { OrderChangeDTO, OrderDTO, ReturnDTO } from "@medusajs/types"
+import { OrderChangeStatus } from "@medusajs/utils"
+import {
+  WorkflowData,
+  createStep,
+  createWorkflow,
+} from "@medusajs/workflows-sdk"
+import { useRemoteQueryStep } from "../../../common"
+import { deleteOrderChangesStep } from "../../steps"
+import {
+  throwIfIsCancelled,
+  throwIfOrderChangeIsNotActive,
+} from "../../utils/order-validation"
+
+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 cancelReturnReceiveWorkflowId = "cancel-receive-return"
+export const cancelReturnReceiveWorkflow = createWorkflow(
+  cancelReturnReceiveWorkflowId,
+  function (input: { return_id: string }): WorkflowData<void> {
+    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", "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", "status", "version"],
+      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 })
+
+    deleteOrderChangesStep({ ids: [orderChange.id] })
+  }
+)
--- a/packages/core/core-flows/src/order/workflows/return/cancel-request-return.ts
+++ b/packages/core/core-flows/src/order/workflows/return/cancel-request-return.ts
@@ -45,7 +45,7 @@ export const cancelReturnRequestWorkflow = createWorkflow(
  function (input: WorkflowInput): WorkflowData<void> {
    const orderReturn: ReturnDTO = useRemoteQueryStep({
      entry_point: "return",
-      fields: ["id", "status", "order_id"],
+      fields: ["id", "status", "order_id", "canceled_at"],
      variables: { id: input.return_id },
      list: false,
      throw_if_key_not_found: true,
@@ -53,7 +53,7 @@ export const cancelReturnRequestWorkflow = createWorkflow(

    const order: OrderDTO = useRemoteQueryStep({
      entry_point: "orders",
-      fields: ["id", "version", "items"],
+      fields: ["id", "version", "canceled_at"],
      variables: { id: orderReturn.order_id },
      list: false,
      throw_if_key_not_found: true,
--- a/packages/core/core-flows/src/order/workflows/return/cancel-return.ts
+++ b/packages/core/core-flows/src/order/workflows/return/cancel-return.ts
@@ -67,6 +67,7 @@ export const cancelReturnWorkflow = createWorkflow(
        entry_point: "return",
        fields: [
          "id",
+          "canceled_at",
          "items.id",
          "items.received_quantity",
          "fulfillments.canceled_at",
--- a/packages/core/core-flows/src/order/workflows/return/confirm-return-request.ts
+++ b/packages/core/core-flows/src/order/workflows/return/confirm-return-request.ts
@@ -42,7 +42,7 @@ export const confirmReturnRequestWorkflow = createWorkflow(
  function (input: WorkflowInput): WorkflowData<OrderDTO> {
    const orderReturn: ReturnDTO = useRemoteQueryStep({
      entry_point: "return",
-      fields: ["id", "status", "order_id"],
+      fields: ["id", "status", "order_id", "canceled_at"],
      variables: { id: input.return_id },
      list: false,
      throw_if_key_not_found: true,
@@ -50,7 +50,7 @@ export const confirmReturnRequestWorkflow = createWorkflow(

    const order: OrderDTO = useRemoteQueryStep({
      entry_point: "orders",
-      fields: ["id", "version", "items"],
+      fields: ["id", "version", "canceled_at"],
      variables: { id: orderReturn.order_id },
      list: false,
      throw_if_key_not_found: true,
--- a/packages/core/core-flows/src/order/workflows/return/create-complete-return.ts
+++ b/packages/core/core-flows/src/order/workflows/return/create-complete-return.ts
@@ -15,15 +15,15 @@ import {
  parallelize,
  transform,
 } from "@medusajs/workflows-sdk"
-import { createRemoteLinkStep, useRemoteQueryStep } from "../../common"
-import { createReturnFulfillmentWorkflow } from "../../fulfillment"
-import { createCompleteReturnStep } from "../steps/create-complete-return"
-import { receiveReturnStep } from "../steps/receive-return"
+import { createRemoteLinkStep, useRemoteQueryStep } from "../../../common"
+import { createReturnFulfillmentWorkflow } from "../../../fulfillment"
+import { createCompleteReturnStep } from "../../steps/create-complete-return"
+import { receiveReturnStep } from "../../steps/receive-return"
 import {
  throwIfItemsDoesNotExistsInOrder,
  throwIfOrderIsCancelled,
-} from "../utils/order-validation"
-import { validateReturnReasons } from "../utils/validate-return-reason"
+} from "../../utils/order-validation"
+import { validateReturnReasons } from "../../utils/validate-return-reason"

 function prepareShippingMethodData({
  orderId,
--- a/packages/core/core-flows/src/order/workflows/return/create-return-shipping-method.ts
+++ b/packages/core/core-flows/src/order/workflows/return/create-return-shipping-method.ts
@@ -48,7 +48,7 @@ export const createReturnShippingMethodWorkflow = createWorkflow(
  }): WorkflowData<OrderDTO> {
    const orderReturn: ReturnDTO = useRemoteQueryStep({
      entry_point: "return",
-      fields: ["id", "status", "order_id"],
+      fields: ["id", "status", "order_id", "canceled_at"],
      variables: { id: input.return_id },
      list: false,
      throw_if_key_not_found: true,
@@ -56,7 +56,7 @@ export const createReturnShippingMethodWorkflow = createWorkflow(

    const order: OrderDTO = useRemoteQueryStep({
      entry_point: "orders",
-      fields: ["id", "status", "currency_code"],
+      fields: ["id", "status", "currency_code", "canceled_at"],
      variables: { id: orderReturn.order_id },
      list: false,
      throw_if_key_not_found: true,
--- a/packages/core/core-flows/src/order/workflows/return/receive-complete-return.ts
+++ b/packages/core/core-flows/src/order/workflows/return/receive-complete-return.ts
@@ -21,7 +21,7 @@ const validationStep = createStep(
      input,
    }: {
      orderReturn
-      input: OrderWorkflow.ReceiveOrderReturnWorkflowInput
+      input: OrderWorkflow.ReceiveCompleteOrderReturnWorkflowInput
    },
    context
  ) {
@@ -30,11 +30,11 @@ const validationStep = createStep(
  }
 )

-export const receiveReturnOrderWorkflowId = "receive-return-order"
-export const receiveReturnOrderWorkflow = createWorkflow(
-  receiveReturnOrderWorkflowId,
+export const receiveAndCompleteReturnOrderWorkflowId = "receive-return-order"
+export const receiveAndCompleteReturnOrderWorkflow = createWorkflow(
+  receiveAndCompleteReturnOrderWorkflowId,
  function (
-    input: WorkflowData<OrderWorkflow.ReceiveOrderReturnWorkflowInput>
+    input: WorkflowData<OrderWorkflow.ReceiveCompleteOrderReturnWorkflowInput>
  ): WorkflowData<ReturnDTO> {
    const orderReturn: ReturnDTO = useRemoteQueryStep({
      entry_point: "returns",
--- a/packages/core/core-flows/src/order/workflows/return/remove-request-item-return.ts
+++ b/packages/core/core-flows/src/order/workflows/return/remove-request-item-return.ts
@@ -62,7 +62,7 @@ export const removeRequestItemReturnWorkflow = createWorkflow(
  ): WorkflowData<OrderDTO> {
    const orderReturn: ReturnDTO = useRemoteQueryStep({
      entry_point: "return",
-      fields: ["id", "status", "order_id"],
+      fields: ["id", "status", "order_id", "canceled_at"],
      variables: { id: input.return_id },
      list: false,
      throw_if_key_not_found: true,
@@ -70,7 +70,7 @@ export const removeRequestItemReturnWorkflow = createWorkflow(

    const order: OrderDTO = useRemoteQueryStep({
      entry_point: "orders",
-      fields: ["id", "status", "items.*"],
+      fields: ["id", "status", "canceled_at", "items.*"],
      variables: { id: orderReturn.order_id },
      list: false,
      throw_if_key_not_found: true,
--- a/packages/core/core-flows/src/order/workflows/return/remove-return-shipping-method.ts
+++ b/packages/core/core-flows/src/order/workflows/return/remove-return-shipping-method.ts
@@ -60,7 +60,7 @@ export const removeReturnShippingMethodWorkflow = createWorkflow(
  ): WorkflowData {
    const orderReturn: ReturnDTO = useRemoteQueryStep({
      entry_point: "return",
-      fields: ["id", "status", "order_id"],
+      fields: ["id", "status", "order_id", "canceled_at"],
      variables: { id: input.return_id },
      list: false,
      throw_if_key_not_found: true,
--- a/packages/core/core-flows/src/order/workflows/return/request-item-return.ts
+++ b/packages/core/core-flows/src/order/workflows/return/request-item-return.ts
@@ -57,7 +57,7 @@ export const requestItemReturnWorkflow = createWorkflow(
  ): WorkflowData<OrderDTO> {
    const orderReturn: ReturnDTO = useRemoteQueryStep({
      entry_point: "return",
-      fields: ["id", "status", "order_id"],
+      fields: ["id", "status", "order_id", "canceled_at"],
      variables: { id: input.return_id },
      list: false,
      throw_if_key_not_found: true,
@@ -65,7 +65,7 @@ export const requestItemReturnWorkflow = createWorkflow(

    const order: OrderDTO = useRemoteQueryStep({
      entry_point: "orders",
-      fields: ["id", "status", "items.*"],
+      fields: ["id", "status", "canceled_at", "items.*"],
      variables: { id: orderReturn.order_id },
      list: false,
      throw_if_key_not_found: true,
--- a/packages/core/core-flows/src/order/workflows/return/update-request-item-return.ts
+++ b/packages/core/core-flows/src/order/workflows/return/update-request-item-return.ts
@@ -77,7 +77,7 @@ export const updateRequestItemReturnWorkflow = createWorkflow(
  ): WorkflowData<OrderDTO> {
    const orderReturn: ReturnDTO = useRemoteQueryStep({
      entry_point: "return",
-      fields: ["id", "status", "order_id"],
+      fields: ["id", "status", "order_id", "canceled_at"],
      variables: { id: input.return_id },
      list: false,
      throw_if_key_not_found: true,
@@ -85,7 +85,7 @@ export const updateRequestItemReturnWorkflow = createWorkflow(

    const order: OrderDTO = useRemoteQueryStep({
      entry_point: "orders",
-      fields: ["id", "status", "items.*"],
+      fields: ["id", "status", "canceled_at", "items.*"],
      variables: { id: orderReturn.order_id },
      list: false,
      throw_if_key_not_found: true,
--- a/packages/core/core-flows/src/order/workflows/return/update-return-shipping-method.ts
+++ b/packages/core/core-flows/src/order/workflows/return/update-return-shipping-method.ts
@@ -62,7 +62,7 @@ export const updateReturnShippingMethodWorkflow = createWorkflow(
  ): WorkflowData {
    const orderReturn: ReturnDTO = useRemoteQueryStep({
      entry_point: "return",
-      fields: ["id", "status", "order_id"],
+      fields: ["id", "status", "order_id", "canceled_at"],
      variables: { id: input.return_id },
      list: false,
      throw_if_key_not_found: true,