feat(core-flows,js-sdk,medusa,types): draft order delete (#12172)

packages/core/core-flows/src/draft-order/steps/delete-draft-order.ts

@@ -0,0 +1,26 @@
+import { IOrderModuleService } from "@medusajs/framework/types"
+import { createStep } from "@medusajs/framework/workflows-sdk"
+import { Modules } from "@medusajs/framework/utils"
+
+/**
+ * The details of canceling the orders.
+ */
+export type DeleteDraftOrdersStepInput = {
+  /**
+   * The IDs of the orders to delete.
+   */
+  orderIds: string[]
+}
+
+export const deleteDraftOrdersStepId = "delete-draft-orders"
+/**
+ * This step deletes one or more draft orders.
+ */
+export const deleteDraftOrdersStep = createStep(
+  deleteDraftOrdersStepId,
+  async (data: DeleteDraftOrdersStepInput, { container }) => {
+    const service = container.resolve<IOrderModuleService>(Modules.ORDER)
+
+    await service.deleteOrders(data.orderIds)
+  }
+)

packages/core/core-flows/src/draft-order/steps/index.ts

@@ -1 +1,2 @@
 export * from "./validate-draft-order"
+export * from "./delete-draft-order"

packages/core/core-flows/src/draft-order/workflows/delete-draft-order.ts

@@ -0,0 +1,85 @@
+import {
+  WorkflowData,
+  WorkflowResponse,
+  createStep,
+  createWorkflow,
+  transform,
+} from "@medusajs/framework/workflows-sdk"
+import { OrderDTO } from "@medusajs/framework/types"
+import { Modules } from "@medusajs/framework/utils"
+
+import { removeRemoteLinkStep, useQueryGraphStep } from "../../common"
+import { deleteDraftOrdersStep } from "../steps"
+
+/**
+ * The data to validate the order's cancelation.
+ */
+export type DeleteDraftOrderStepInput = {
+  /**
+   * The order ids to delete.
+   */
+  order_ids: string[]
+}
+
+const validateDraftOrdersStep = createStep(
+  "validate-draft-orders",
+  async (data: { orders: OrderDTO[] }) => {
+    if (
+      data.orders.some(
+        (order) => order.status !== "draft" || !order.is_draft_order
+      )
+    ) {
+      throw new Error("One or more orders are not draft")
+    }
+
+    if (data.orders.some((order) => order.deleted_at)) {
+      throw new Error("One or more orders are already deleted")
+    }
+  }
+)
+
+export const deleteDraftOrderWorkflowId = "delete-draft-order"
+/**
+ * This workflow deletes draft orders.
+ *
+ * You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around canceling an order.
+ *
+ * @example
+ * const { result } = await deleteDraftOrderWorkflow(container)
+ * .run({
+ *   input: {
+ *     order_ids: ["order_123", "order_456"],
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Delete draft orders.
+ *
+ * @property hooks.orderCanceled - This hook is executed after the order is canceled. You can consume this hook to perform custom actions on the canceled order.
+ */
+export const deleteDraftOrdersWorkflow = createWorkflow(
+  deleteDraftOrderWorkflowId,
+  (input: WorkflowData<DeleteDraftOrderStepInput>) => {
+    const orderQuery = useQueryGraphStep({
+      entity: "orders",
+      fields: ["id", "status", "is_draft_order", "deleted_at"],
+      filters: { id: input.order_ids },
+      options: { throwIfKeyNotFound: true },
+    }).config({ name: "get-draft-order" })
+
+    const orders = transform({ orderQuery }, ({ orderQuery }) => {
+      return orderQuery.data
+    })
+
+    validateDraftOrdersStep({ orders })
+
+    removeRemoteLinkStep({
+      [Modules.ORDER]: { order_id: input.order_ids },
+    })
+
+    deleteDraftOrdersStep({ orderIds: input.order_ids })
+
+    return new WorkflowResponse(void 0)
+  }
+)

packages/core/core-flows/src/draft-order/workflows/index.ts

@@ -15,3 +15,4 @@ export * from "./update-draft-order-action-shipping-method"
 export * from "./update-draft-order-item"
 export * from "./update-draft-order-shipping-method"
 export * from "./remove-draft-order-shipping-method"
+export * from "./delete-draft-order"