Files
medusa-store/packages/admin/dashboard/src/hooks/api/campaigns.tsx
T
Kasper Fabricius Kristensen 0fe1201435 feat(admin-sdk,admin-bundler,admin-shared,medusa): Restructure admin packages (#8988)
**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.
2024-09-04 19:00:25 +00:00

136 lines
3.5 KiB
TypeScript

import { HttpTypes, LinkMethodRequest } from "@medusajs/types"
import {
QueryKey,
UseMutationOptions,
UseQueryOptions,
useMutation,
useQuery,
} from "@tanstack/react-query"
import { sdk } from "../../lib/client"
import { queryClient } from "../../lib/query-client"
import { queryKeysFactory } from "../../lib/query-key-factory"
import { promotionsQueryKeys } from "./promotions"
import { FetchError } from "@medusajs/js-sdk"
const REGIONS_QUERY_KEY = "campaigns" as const
export const campaignsQueryKeys = queryKeysFactory(REGIONS_QUERY_KEY)
export const useCampaign = (
id: string,
query?: HttpTypes.AdminGetCampaignParams,
options?: Omit<
UseQueryOptions<
HttpTypes.AdminCampaignResponse,
FetchError,
HttpTypes.AdminCampaignResponse,
QueryKey
>,
"queryFn" | "queryKey"
>
) => {
const { data, ...rest } = useQuery({
queryKey: campaignsQueryKeys.detail(id),
queryFn: async () => sdk.admin.campaign.retrieve(id, query),
...options,
})
return { ...data, ...rest }
}
export const useCampaigns = (
query?: HttpTypes.AdminGetCampaignsParams,
options?: Omit<
UseQueryOptions<
HttpTypes.AdminCampaignListResponse,
FetchError,
HttpTypes.AdminCampaignListResponse,
QueryKey
>,
"queryFn" | "queryKey"
>
) => {
const { data, ...rest } = useQuery({
queryFn: () => sdk.admin.campaign.list(query),
queryKey: campaignsQueryKeys.list(query),
...options,
})
return { ...data, ...rest }
}
export const useCreateCampaign = (
options?: UseMutationOptions<
HttpTypes.AdminCampaignResponse,
FetchError,
HttpTypes.AdminCreateCampaign
>
) => {
return useMutation({
mutationFn: (payload) => sdk.admin.campaign.create(payload),
onSuccess: (data, variables, context) => {
queryClient.invalidateQueries({ queryKey: campaignsQueryKeys.lists() })
options?.onSuccess?.(data, variables, context)
},
...options,
})
}
export const useUpdateCampaign = (
id: string,
options?: UseMutationOptions<
HttpTypes.AdminCampaignResponse,
FetchError,
HttpTypes.AdminUpdateCampaign
>
) => {
return useMutation({
mutationFn: (payload) => sdk.admin.campaign.update(id, payload),
onSuccess: (data, variables, context) => {
queryClient.invalidateQueries({ queryKey: campaignsQueryKeys.lists() })
queryClient.invalidateQueries({ queryKey: campaignsQueryKeys.details() })
options?.onSuccess?.(data, variables, context)
},
...options,
})
}
export const useDeleteCampaign = (
id: string,
options?: UseMutationOptions<
HttpTypes.DeleteResponse<"campaign">,
FetchError,
void
>
) => {
return useMutation({
mutationFn: () => sdk.admin.campaign.delete(id),
onSuccess: (data, variables, context) => {
queryClient.invalidateQueries({ queryKey: campaignsQueryKeys.lists() })
queryClient.invalidateQueries({ queryKey: campaignsQueryKeys.details() })
options?.onSuccess?.(data, variables, context)
},
...options,
})
}
export const useAddOrRemoveCampaignPromotions = (
id: string,
options?: UseMutationOptions<
HttpTypes.AdminCampaignResponse,
FetchError,
LinkMethodRequest
>
) => {
return useMutation({
mutationFn: (payload) => sdk.admin.campaign.batchPromotions(id, payload),
onSuccess: (data, variables, context) => {
queryClient.invalidateQueries({ queryKey: campaignsQueryKeys.details() })
queryClient.invalidateQueries({ queryKey: promotionsQueryKeys.lists() })
options?.onSuccess?.(data, variables, context)
},
...options,
})
}