**What** - Renames /admin-next -> /admin - Renames @medusajs/admin-sdk -> @medusajs/admin-bundler - Creates a new package called @medusajs/admin-sdk that will hold all tooling relevant to creating admin extensions. This is currently `defineRouteConfig` and `defineWidgetConfig`, but will eventually also export methods for adding custom fields, register translation, etc. - cc: @shahednasser we should update the examples in the docs so these functions are imported from `@medusajs/admin-sdk`. People will also need to install the package in their project, as it's no longer a transient dependency. - cc: @olivermrbl we might want to publish a changelog when this is merged, as it is a breaking change, and will require people to import the `defineXConfig` from the new package instead of `@medusajs/admin-shared`. - Updates CODEOWNERS so /admin packages does not require a review from the UI team.
211 lines
5.1 KiB
TypeScript
211 lines
5.1 KiB
TypeScript
import {
|
|
QueryKey,
|
|
useMutation,
|
|
UseMutationOptions,
|
|
useQuery,
|
|
UseQueryOptions,
|
|
} from "@tanstack/react-query"
|
|
import { FetchError } from "@medusajs/js-sdk"
|
|
import { HttpTypes } from "@medusajs/types"
|
|
import { sdk } from "../../lib/client"
|
|
import { queryClient } from "../../lib/query-client"
|
|
import { queryKeysFactory, TQueryKey } from "../../lib/query-key-factory"
|
|
|
|
const ORDERS_QUERY_KEY = "orders" as const
|
|
const _orderKeys = queryKeysFactory(ORDERS_QUERY_KEY) as TQueryKey<
|
|
"orders",
|
|
any,
|
|
string
|
|
> & {
|
|
preview: (orderId: string) => any
|
|
changes: (orderId: string) => any
|
|
}
|
|
|
|
_orderKeys.preview = function (id: string) {
|
|
return [this.detail(id), "preview"]
|
|
}
|
|
|
|
_orderKeys.changes = function (id: string) {
|
|
return [this.detail(id), "changes"]
|
|
}
|
|
|
|
export const ordersQueryKeys = _orderKeys
|
|
|
|
export const useOrder = (
|
|
id: string,
|
|
query?: Record<string, any>,
|
|
options?: Omit<
|
|
UseQueryOptions<any, FetchError, any, QueryKey>,
|
|
"queryFn" | "queryKey"
|
|
>
|
|
) => {
|
|
const { data, ...rest } = useQuery({
|
|
queryFn: async () => sdk.admin.order.retrieve(id, query),
|
|
queryKey: ordersQueryKeys.detail(id, query),
|
|
...options,
|
|
})
|
|
|
|
return { ...data, ...rest }
|
|
}
|
|
|
|
export const useOrderPreview = (
|
|
id: string,
|
|
query?: HttpTypes.AdminOrderFilters,
|
|
options?: Omit<
|
|
UseQueryOptions<
|
|
HttpTypes.AdminOrderPreviewResponse,
|
|
FetchError,
|
|
HttpTypes.AdminOrderPreviewResponse,
|
|
QueryKey
|
|
>,
|
|
"queryFn" | "queryKey"
|
|
>
|
|
) => {
|
|
const { data, ...rest } = useQuery({
|
|
queryFn: async () => sdk.admin.order.retrievePreview(id, query),
|
|
queryKey: ordersQueryKeys.preview(id),
|
|
...options,
|
|
})
|
|
|
|
return { ...data, ...rest }
|
|
}
|
|
|
|
export const useOrders = (
|
|
query?: Record<string, any>,
|
|
options?: Omit<
|
|
UseQueryOptions<any, FetchError, any, QueryKey>,
|
|
"queryFn" | "queryKey"
|
|
>
|
|
) => {
|
|
const { data, ...rest } = useQuery({
|
|
queryFn: async () => sdk.admin.order.list(query),
|
|
queryKey: ordersQueryKeys.list(query),
|
|
...options,
|
|
})
|
|
|
|
return { ...data, ...rest }
|
|
}
|
|
|
|
export const useOrderChanges = (
|
|
id: string,
|
|
query?: HttpTypes.AdminOrderChangesFilters,
|
|
options?: Omit<
|
|
UseQueryOptions<
|
|
HttpTypes.AdminOrderChangesResponse,
|
|
Error,
|
|
HttpTypes.AdminOrderChangesResponse,
|
|
QueryKey
|
|
>,
|
|
"queryFn" | "queryKey"
|
|
>
|
|
) => {
|
|
const { data, ...rest } = useQuery({
|
|
queryFn: async () => sdk.admin.order.listChanges(id, query),
|
|
queryKey: ordersQueryKeys.changes(id),
|
|
...options,
|
|
})
|
|
|
|
return { ...data, ...rest }
|
|
}
|
|
|
|
export const useCreateOrderFulfillment = (
|
|
orderId: string,
|
|
options?: UseMutationOptions<
|
|
HttpTypes.AdminOrderResponse,
|
|
FetchError,
|
|
HttpTypes.AdminCreateOrderFulfillment
|
|
>
|
|
) => {
|
|
return useMutation({
|
|
mutationFn: (payload: HttpTypes.AdminCreateOrderFulfillment) =>
|
|
sdk.admin.order.createFulfillment(orderId, payload),
|
|
onSuccess: (data: any, variables: any, context: any) => {
|
|
queryClient.invalidateQueries({
|
|
queryKey: ordersQueryKeys.details(),
|
|
})
|
|
|
|
queryClient.invalidateQueries({
|
|
queryKey: ordersQueryKeys.preview(orderId),
|
|
})
|
|
|
|
queryClient.invalidateQueries({
|
|
queryKey: ordersQueryKeys.preview(orderId),
|
|
})
|
|
|
|
options?.onSuccess?.(data, variables, context)
|
|
},
|
|
...options,
|
|
})
|
|
}
|
|
|
|
export const useCancelOrderFulfillment = (
|
|
orderId: string,
|
|
fulfillmentId: string,
|
|
options?: UseMutationOptions<any, FetchError, any>
|
|
) => {
|
|
return useMutation({
|
|
mutationFn: (payload: { no_notification?: boolean }) =>
|
|
sdk.admin.order.cancelFulfillment(orderId, fulfillmentId, payload),
|
|
onSuccess: (data: any, variables: any, context: any) => {
|
|
queryClient.invalidateQueries({
|
|
queryKey: ordersQueryKeys.details(),
|
|
})
|
|
|
|
queryClient.invalidateQueries({
|
|
queryKey: ordersQueryKeys.preview(orderId),
|
|
})
|
|
|
|
options?.onSuccess?.(data, variables, context)
|
|
},
|
|
...options,
|
|
})
|
|
}
|
|
|
|
export const useCreateOrderShipment = (
|
|
orderId: string,
|
|
fulfillmentId: string,
|
|
options?: UseMutationOptions<
|
|
{ order: HttpTypes.AdminOrder },
|
|
FetchError,
|
|
HttpTypes.AdminCreateOrderShipment
|
|
>
|
|
) => {
|
|
return useMutation({
|
|
mutationFn: (payload: HttpTypes.AdminCreateOrderShipment) =>
|
|
sdk.admin.order.createShipment(orderId, fulfillmentId, payload),
|
|
onSuccess: (data: any, variables: any, context: any) => {
|
|
queryClient.invalidateQueries({
|
|
queryKey: ordersQueryKeys.details(),
|
|
})
|
|
|
|
queryClient.invalidateQueries({
|
|
queryKey: ordersQueryKeys.preview(orderId),
|
|
})
|
|
|
|
options?.onSuccess?.(data, variables, context)
|
|
},
|
|
...options,
|
|
})
|
|
}
|
|
|
|
export const useCancelOrder = (
|
|
orderId: string,
|
|
options?: UseMutationOptions<any, FetchError, any>
|
|
) => {
|
|
return useMutation({
|
|
mutationFn: (id) => sdk.admin.order.cancel(id),
|
|
onSuccess: (data: any, variables: any, context: any) => {
|
|
queryClient.invalidateQueries({
|
|
queryKey: ordersQueryKeys.details(),
|
|
})
|
|
|
|
queryClient.invalidateQueries({
|
|
queryKey: ordersQueryKeys.preview(orderId),
|
|
})
|
|
|
|
options?.onSuccess?.(data, variables, context)
|
|
},
|
|
...options,
|
|
})
|
|
}
|