feat(dashboard) admin 3.0 return creation

packages/admin-next/dashboard/public/locales/en-US/translation.json

@@ -19,14 +19,14 @@
     "is": "is",
     "select": "Select",
     "selected": "Selected",
-    "details": "Details",
     "enabled": "Enabled",
     "disabled": "Disabled",
     "expired": "Expired",
     "active": "Active",
     "revoked": "Revoked",
     "admin": "Admin",
     "store": "Store",
+    "details": "Details",
     "items_one": "{{count}} item",
     "items_other": "{{count}} items",
     "countSelected": "{{count}} selected",
@@ -50,12 +50,13 @@
     "settings": "Settings"
   },
   "actions": {
+    "save": "Save",
     "create": "Create",
     "delete": "Delete",
     "remove": "Remove",
     "revoke": "Revoke",
     "cancel": "Cancel",
-    "save": "Save",
+    "back": "Back",
     "continue": "Continue",
     "confirm": "Confirm",
     "edit": "Edit",
@@ -239,6 +240,7 @@
     "cancelWarning": "You are about to cancel the order {{id}}. This action cannot be undone.",
     "onDateFromSalesChannel": "{{date}} from {{salesChannel}}",
     "summary": {
+      "requestReturn": "Request return",
       "allocateItems": "Allocate items",
       "editItems": "Edit items"
     },
@@ -270,6 +272,28 @@
       "newTotal": "New total",
       "differenceDue": "Difference due"
     },
+    "returns": {
+      "details": "Details",
+      "chooseItems": "Choose items",
+      "refundAmount": "Refund amount",
+      "locationDescription": "Choose which location you want to return the items to.",
+      "shippingDescription": "Choose which method you want to use for this return.",
+      "noInventoryLevel": "No inventory level",
+      "sendNotification": "Send notification",
+      "sendNotificationHint": "Notify customer of created return.",
+      "customRefund": "Custom refund",
+      "shippingPriceTooltip1": "Custom refund is enabled",
+      "noShippingOptions": "There are no shipping options for the region",
+      "shippingPriceTooltip2": "Shipping needs to be selected",
+      "customRefundHint": "If you want to refund something else instead of the total refund.",
+      "customShippingPrice": "Custom shipping",
+      "customShippingPriceHint": "Custom shipping cost.",
+      "noInventoryLevelDesc": "The selected location does not have an inventory level for the selected items. The return can be requested but can’t be received until an inventory level is created for the selected location.",
+      "refundableAmountLabel": "Refundable amount",
+      "refundableAmountHeader": "Refundable Amount",
+      "returnableQuantityLabel": "Returnable quantity",
+      "returnableQuantityHeader": "Returnable Quantity"
+    },
     "reservations": {
       "allocatedLabel": "Allocated",
       "notAllocatedLabel": "Not allocated"
@@ -721,6 +745,8 @@
     "limit": "Limit",
     "tags": "Tags",
     "type": "Type",
+    "reason": "Reason",
+    "note": "Note",
     "none": "none",
     "all": "all",
     "percentage": "Percentage",

packages/admin-next/dashboard/src/lib/cast-number.ts

@@ -0,0 +1,6 @@
+/**
+ * Helper function to cast a z.union([z.number(), z.string()]) to a number
+ */
+export const castNumber = (number: number | string) => {
+  return typeof number === "string" ? Number(number.replace(",", ".")) : number
+}

packages/admin-next/dashboard/src/lib/rma.ts

@@ -0,0 +1,75 @@
+import { ClaimItem, LineItem, Order } from "@medusajs/medusa"
+
+/**
+ * Return line items that are returnable from an order
+ * @param order
+ * @param isClaim
+ */
+export const getAllReturnableItems = (
+  order: Omit<Order, "beforeInserts">,
+  isClaim: boolean
+) => {
+  let orderItems = order.items.reduce(
+    (map, obj) =>
+      map.set(obj.id, {
+        ...obj,
+      }),
+    new Map<string, Omit<LineItem, "beforeInsert">>()
+  )
+
+  let claimedItems: ClaimItem[] = []
+
+  if (order.claims && order.claims.length) {
+    for (const claim of order.claims) {
+      if (claim.return_order?.status !== "canceled") {
+        claim.claim_items = claim.claim_items ?? []
+        claimedItems = [...claimedItems, ...claim.claim_items]
+      }
+
+      if (
+        claim.fulfillment_status === "not_fulfilled" &&
+        claim.payment_status === "na"
+      ) {
+        continue
+      }
+
+      if (claim.additional_items && claim.additional_items.length) {
+        orderItems = claim.additional_items
+          .filter(
+            (it) =>
+              it.shipped_quantity ||
+              it.shipped_quantity === it.fulfilled_quantity
+          )
+          .reduce((map, obj) => map.set(obj.id, { ...obj }), orderItems)
+      }
+    }
+  }
+
+  if (!isClaim) {
+    if (order.swaps && order.swaps.length) {
+      for (const swap of order.swaps) {
+        if (swap.fulfillment_status === "not_fulfilled") {
+          continue
+        }
+
+        orderItems = swap.additional_items.reduce(
+          (map, obj) =>
+            map.set(obj.id, {
+              ...obj,
+            }),
+          orderItems
+        )
+      }
+    }
+  }
+
+  for (const item of claimedItems) {
+    const i = orderItems.get(item.item_id)
+    if (i) {
+      i.quantity = i.quantity - item.quantity
+      i.quantity !== 0 ? orderItems.set(i.id, i) : orderItems.delete(i.id)
+    }
+  }
+
+  return [...orderItems.values()]
+}

packages/admin-next/dashboard/src/providers/router-provider/v1.tsx

@@ -2,8 +2,8 @@ import type {
   AdminCollectionsRes,
   AdminCustomerGroupsRes,
   AdminCustomersRes,
-  AdminDraftOrdersRes,
   AdminDiscountsRes,
+  AdminDraftOrdersRes,
   AdminGiftCardsRes,
   AdminOrdersRes,
   AdminProductsRes,
@@ -124,6 +124,11 @@ export const v1Routes: RouteObject[] = [
                     path: "edit",
                     lazy: () => import("../../routes/orders/order-edit"),
                   },
+                  {
+                    path: "returns",
+                    lazy: () =>
+                      import("../../routes/orders/order-create-return"),
+                  },
                 ],
               },
             ],

packages/admin-next/dashboard/src/routes/orders/order-create-return/components/order-create-return-form/constants.ts

@@ -0,0 +1,16 @@
+import { z } from "zod"
+
+export const CreateReturnSchema = z.object({
+  quantity: z.record(z.string(), z.number()),
+  reason: z.record(z.string(), z.string().optional()),
+  note: z.record(z.string(), z.string().optional()),
+  location: z.string(),
+  shipping: z.string(),
+  send_notification: z.boolean().optional(),
+
+  enable_custom_refund: z.boolean().optional(),
+  enable_custom_shipping_price: z.boolean().optional(),
+
+  custom_refund: z.union([z.string(), z.number()]).optional(),
+  custom_shipping_price: z.union([z.string(), z.number()]).optional(),
+})

packages/admin-next/dashboard/src/routes/orders/order-create-return/components/order-create-return-form/index.ts

@@ -0,0 +1 @@
+export { OrderCreateReturnForm as CreateReturns } from "./order-create-return-form"

packages/admin-next/dashboard/src/routes/orders/order-create-return/components/order-create-return-form/order-create-return-details/index.ts

@@ -0,0 +1 @@
+export * from "./order-create-return-details"