Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Use /admin/returns/:id/returns for swap returns #1041

Merged
merged 1 commit into from
Feb 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 9 additions & 19 deletions packages/medusa-js/src/resources/admin/orders.ts
Original file line number Diff line number Diff line change
@@ -1,22 +1,21 @@
import {
AdminPostOrdersOrderReq,
AdminOrdersRes,
AdminGetOrdersParams,
AdminOrdersListRes,
AdminPostOrdersReq,
AdminPostOrdersOrderRefundsReq,
AdminOrdersRes,
AdminPostOrdersOrderClaimsClaimFulfillmentsReq,
AdminPostOrdersOrderClaimsClaimReq,
AdminPostOrdersOrderClaimsClaimShipmentsReq,
AdminPostOrdersOrderClaimsReq,
AdminPostOrdersOrderFulfillmentsReq,
AdminPostOrdersOrderShipmentReq,
AdminPostOrdersOrderRefundsReq,
AdminPostOrdersOrderReq,
AdminPostOrdersOrderReturnsReq,
AdminPostOrdersOrderShipmentReq,
AdminPostOrdersOrderShippingMethodsReq,
AdminPostOrdersOrderSwapsReq,
AdminPostOrdersOrderSwapsSwapReceiveReq,
AdminPostOrdersOrderSwapsSwapFulfillmentsReq,
AdminPostOrdersOrderSwapsSwapShipmentsReq,
AdminPostOrdersOrderClaimsReq,
AdminPostOrdersOrderClaimsClaimFulfillmentsReq,
AdminPostOrdersOrderClaimsClaimShipmentsReq,
AdminPostOrdersOrderClaimsClaimReq,
AdminPostOrdersReq,
} from "@medusajs/medusa"
import qs from "qs"
import { ResponsePromise } from "../../typings"
Expand Down Expand Up @@ -151,15 +150,6 @@ class AdminOrdersResource extends BaseResource {
return this.client.request("POST", path)
}

receiveSwap(
id: string,
swapId: string,
payload: AdminPostOrdersOrderSwapsSwapReceiveReq
): ResponsePromise<AdminOrdersRes> {
const path = `/admin/orders/${id}/swaps/${swapId}/receive`
return this.client.request("POST", path, payload)
}

fulfillSwap(
id: string,
swapId: string,
Expand Down
9 changes: 7 additions & 2 deletions packages/medusa-js/src/resources/admin/returns.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import {
AdminGetReturnsParams,
AdminPostReturnsReturnReceiveReq,
AdminReturnsCancelRes,
AdminReturnsListRes,
AdminReturnsRes,
Expand All @@ -22,11 +23,15 @@ class AdminReturnsResource extends BaseResource {
/**
* @description receive a return
* @param id id of the return to receive.
* @param payload items to receive and an optional refund amount
* @returns the return
*/
receive(id: string): ResponsePromise<AdminReturnsRes> {
receive(
id: string,
payload: AdminPostReturnsReturnReceiveReq
): ResponsePromise<AdminReturnsRes> {
const path = `/admin/returns/${id}/receive`
return this.client.request("POST", path)
return this.client.request("POST", path, payload)
}

/**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import { adminDraftOrderKeys } from "./queries"
import {
AdminDraftOrdersDeleteRes,
AdminDraftOrdersRes,
Expand All @@ -11,6 +10,7 @@ import { Response } from "@medusajs/medusa-js"
import { useMutation, UseMutationOptions, useQueryClient } from "react-query"
import { useMedusa } from "../../../contexts/medusa"
import { buildOptions } from "../../utils/buildOptions"
import { adminDraftOrderKeys } from "./queries"

export const useAdminCreateDraftOrder = (
options?: UseMutationOptions<
Expand Down
14 changes: 11 additions & 3 deletions packages/medusa-react/src/hooks/admin/returns/mutations.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
import { AdminReturnsCancelRes, AdminReturnsRes } from "@medusajs/medusa"
import {
AdminPostReturnsReturnReceiveReq,
AdminReturnsCancelRes,
AdminReturnsRes,
} from "@medusajs/medusa"
import { Response } from "@medusajs/medusa-js"
import { useMutation, UseMutationOptions, useQueryClient } from "react-query"
import { useMedusa } from "../../../contexts/medusa"
Expand All @@ -7,13 +11,17 @@ import { adminReturnKeys } from "./queries"

export const useAdminReceiveReturn = (
id: string,
options?: UseMutationOptions<Response<AdminReturnsRes>, Error, void>
options?: UseMutationOptions<
Response<AdminReturnsRes>,
Error,
AdminPostReturnsReturnReceiveReq
>
) => {
const { client } = useMedusa()
const queryClient = useQueryClient()

return useMutation(
() => client.admin.returns.receive(id),
payload => client.admin.returns.receive(id, payload),
buildOptions(
queryClient,
[adminReturnKeys.detail(id), adminReturnKeys.list()],
Expand Down
28 changes: 1 addition & 27 deletions packages/medusa-react/src/hooks/admin/swaps/mutations.ts
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
import { adminSwapKeys } from "./queries"
import {
AdminOrdersRes,
AdminPostOrdersOrderSwapsReq,
AdminPostOrdersOrderSwapsSwapFulfillmentsReq,
AdminPostOrdersOrderSwapsSwapReceiveReq,
AdminPostOrdersOrderSwapsSwapShipmentsReq,
} from "@medusajs/medusa"
import { Response } from "@medusajs/medusa-js"
import { useMutation, UseMutationOptions, useQueryClient } from "react-query"
import { adminOrderKeys } from ".."
import { useMedusa } from "../../../contexts/medusa"
import { buildOptions } from "../../utils/buildOptions"
import { adminSwapKeys } from "./queries"

export const useAdminCreateSwap = (
orderId: string,
Expand Down Expand Up @@ -50,31 +49,6 @@ export const useAdminCancelSwap = (
)
}

export const useAdminReceiveSwap = (
orderId: string,
options?: UseMutationOptions<
Response<AdminOrdersRes>,
Error,
AdminPostOrdersOrderSwapsSwapReceiveReq & { swap_id: string }
>
) => {
const { client } = useMedusa()
const queryClient = useQueryClient()

return useMutation(
({
swap_id,
...payload
}: AdminPostOrdersOrderSwapsSwapReceiveReq & { swap_id: string }) =>
client.admin.orders.receiveSwap(orderId, swap_id, payload),
buildOptions(
queryClient,
[adminOrderKeys.detail(orderId), adminSwapKeys.lists()],
options
)
)
}

export const useAdminFulfillSwap = (
orderId: string,
options?: UseMutationOptions<
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { useAdminCancelReturn, useAdminReceiveReturn } from "../../../../src/"
import { renderHook } from "@testing-library/react-hooks"
import { fixtures } from "../../../../mocks/data"
import { useAdminCancelReturn, useAdminReceiveReturn } from "../../../../src/"
import { createWrapper } from "../../../utils"

describe("useAdminCancel hook", () => {
Expand All @@ -23,14 +23,23 @@ describe("useAdminCancel hook", () => {

describe("useAdminReceiveReturn hook", () => {
test("marks a return as received", async () => {
const payload = {
items: [
{
item_id: "test_id",
quantity: 1,
},
],
}

const { result, waitFor } = renderHook(
() => useAdminReceiveReturn("test-return"),
{
wrapper: createWrapper(),
}
)

result.current.mutate()
result.current.mutate({ ...payload })

await waitFor(() => result.current.isSuccess)

Expand Down
37 changes: 5 additions & 32 deletions packages/medusa-react/test/hooks/admin/swaps/mutations.test.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
import { renderHook } from "@testing-library/react-hooks"
import { fixtures } from "../../../../mocks/data"
import {
useAdminCreateSwap,
useAdminReceiveSwap,
useAdminFulfillSwap,
useAdminCancelSwap,
useAdminCancelSwapFulfillment,
useAdminCreateSwap,
useAdminCreateSwapShipment,
useAdminFulfillSwap,
useAdminProcessSwapPayment,
useAdminCancelSwapFulfillment,
} from "../../../../src/"
import { renderHook } from "@testing-library/react-hooks"
import { fixtures } from "../../../../mocks/data"
import { createWrapper } from "../../../utils"

describe("useAdminCreateSwap hook", () => {
Expand Down Expand Up @@ -42,32 +41,6 @@ describe("useAdminCreateSwap hook", () => {
})
})

describe("useAdminReceiveSwap hook", () => {
test("receives a swap", async () => {
const orderId = fixtures.get("order").id
const swapId = "test-swap"
const payload = {
items: [
{
item_id: "test_id",
quantity: 1,
},
],
}

const { result, waitFor } = renderHook(() => useAdminReceiveSwap(orderId), {
wrapper: createWrapper(),
})

result.current.mutate({ swap_id: swapId, ...payload })

await waitFor(() => result.current.isSuccess)

expect(result.current.data.response.status).toEqual(200)
expect(result.current.data.order).toEqual(fixtures.get("order"))
})
})

describe("useAdminFulfillSwap hook", () => {
test("receives a swap", async () => {
const orderId = fixtures.get("order").id
Expand Down