feat(sdk): Replace region calls with the SDK in admin, apply typings … (

medusajs#7371)

.changeset/silver-coats-learn.md

@@ -0,0 +1,7 @@
+---
+"@medusajs/dashboard": patch
+"@medusajs/js-sdk": patch
+"@medusajs/types": patch
+---
+
+Replace region calls with the SDK in admin, apply typings to sdk

packages/admin-next/dashboard/src/hooks/api/auth.tsx

@@ -7,7 +7,7 @@ export const useEmailPassLogin = (
   options?: UseMutationOptions<void, Error, EmailPassReq>
 ) => {
   return useMutation({
-    mutationFn: (payload) => sdk.auth.login(payload),
+    mutationFn: (payload) => sdk.auth.login("admin", "emailpass", payload),
     onSuccess: async (data, variables, context) => {
       options?.onSuccess?.(data, variables, context)
     },

packages/admin-next/dashboard/src/hooks/api/regions.tsx

@@ -5,15 +5,10 @@ import {
   useMutation,
   useQuery,
 } from "@tanstack/react-query"
-import { client } from "../../lib/client"
+import { sdk } from "../../lib/client"
 import { queryClient } from "../../lib/medusa"
 import { queryKeysFactory } from "../../lib/query-key-factory"
-import { CreateRegionReq, UpdateRegionReq } from "../../types/api-payloads"
-import {
-  RegionDeleteRes,
-  RegionListRes,
-  RegionRes,
-} from "../../types/api-responses"
+import { DeleteResponse, HttpTypes, PaginatedResponse } from "@medusajs/types"
 
 const REGIONS_QUERY_KEY = "regions" as const
 const regionsQueryKeys = queryKeysFactory(REGIONS_QUERY_KEY)
@@ -22,13 +17,18 @@ export const useRegion = (
   id: string,
   query?: Record<string, any>,
   options?: Omit<
-    UseQueryOptions<RegionRes, Error, RegionRes, QueryKey>,
+    UseQueryOptions<
+      { region: HttpTypes.AdminRegion },
+      Error,
+      { region: HttpTypes.AdminRegion },
+      QueryKey
+    >,
     "queryFn" | "queryKey"
   >
 ) => {
   const { data, ...rest } = useQuery({
     queryKey: regionsQueryKeys.detail(id),
-    queryFn: async () => client.regions.retrieve(id, query),
+    queryFn: async () => sdk.admin.region.retrieve(id, query),
     ...options,
   })
 
@@ -38,12 +38,17 @@ export const useRegion = (
 export const useRegions = (
   query?: Record<string, any>,
   options?: Omit<
-    UseQueryOptions<RegionListRes, Error, RegionListRes, QueryKey>,
+    UseQueryOptions<
+      PaginatedResponse<{ regions: HttpTypes.AdminRegion[] }>,
+      Error,
+      PaginatedResponse<{ regions: HttpTypes.AdminRegion[] }>,
+      QueryKey
+    >,
     "queryFn" | "queryKey"
   >
 ) => {
   const { data, ...rest } = useQuery({
-    queryFn: () => client.regions.list(query),
+    queryFn: () => sdk.admin.region.list(query),
     queryKey: regionsQueryKeys.list(query),
     ...options,
   })
@@ -52,10 +57,14 @@ export const useRegions = (
 }
 
 export const useCreateRegion = (
-  options?: UseMutationOptions<RegionRes, Error, CreateRegionReq>
+  options?: UseMutationOptions<
+    { region: HttpTypes.AdminRegion },
+    Error,
+    HttpTypes.AdminCreateRegion
+  >
 ) => {
   return useMutation({
-    mutationFn: (payload) => client.regions.create(payload),
+    mutationFn: (payload) => sdk.admin.region.create(payload),
     onSuccess: (data, variables, context) => {
       queryClient.invalidateQueries({ queryKey: regionsQueryKeys.lists() })
       options?.onSuccess?.(data, variables, context)
@@ -66,10 +75,14 @@ export const useCreateRegion = (
 
 export const useUpdateRegion = (
   id: string,
-  options?: UseMutationOptions<RegionRes, Error, UpdateRegionReq>
+  options?: UseMutationOptions<
+    { region: HttpTypes.AdminRegion },
+    Error,
+    HttpTypes.AdminUpdateRegion
+  >
 ) => {
   return useMutation({
-    mutationFn: (payload) => client.regions.update(id, payload),
+    mutationFn: (payload) => sdk.admin.region.update(id, payload),
     onSuccess: (data, variables, context) => {
       queryClient.invalidateQueries({ queryKey: regionsQueryKeys.lists() })
       queryClient.invalidateQueries({ queryKey: regionsQueryKeys.detail(id) })
@@ -82,10 +95,10 @@ export const useUpdateRegion = (
 
 export const useDeleteRegion = (
   id: string,
-  options?: UseMutationOptions<RegionDeleteRes, Error, void>
+  options?: UseMutationOptions<DeleteResponse<"region">, Error, void>
 ) => {
   return useMutation({
-    mutationFn: () => client.regions.delete(id),
+    mutationFn: () => sdk.admin.region.delete(id),
     onSuccess: (data, variables, context) => {
       queryClient.invalidateQueries({ queryKey: regionsQueryKeys.lists() })
       queryClient.invalidateQueries({ queryKey: regionsQueryKeys.detail(id) })

packages/admin-next/dashboard/src/hooks/table/columns/use-region-table-columns.tsx

@@ -1,6 +1,5 @@
 import { createColumnHelper } from "@tanstack/react-table"
 import { useMemo } from "react"
-import { RegionDTO } from "@medusajs/types"
 
 import {
   CountriesCell,
@@ -14,8 +13,9 @@ import {
   RegionCell,
   RegionHeader,
 } from "../../../components/table/table-cells/region/region-cell"
+import { HttpTypes } from "@medusajs/types"
 
-const columnHelper = createColumnHelper<RegionDTO>()
+const columnHelper = createColumnHelper<HttpTypes.AdminRegion>()
 
 export const useRegionTableColumns = () => {
   return useMemo(

packages/admin-next/dashboard/src/hooks/table/query/use-region-table-query.tsx

@@ -1,4 +1,4 @@
-import { AdminGetRegionsParams } from "@medusajs/medusa"
+import { FindParams, HttpTypes } from "@medusajs/types"
 import { useQueryParams } from "../../use-query-params"
 
 type UseRegionTableQueryProps = {
@@ -17,7 +17,7 @@ export const useRegionTableQuery = ({
 
   const { offset, q, order, created_at, updated_at } = queryObject
 
-  const searchParams: AdminGetRegionsParams = {
+  const searchParams: FindParams & HttpTypes.AdminRegionFilters = {
     limit: pageSize,
     offset: offset ? Number(offset) : 0,
     order,

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

@@ -14,7 +14,6 @@ import { priceLists } from "./price-lists"
 import { productTypes } from "./product-types"
 import { products } from "./products"
 import { promotions } from "./promotions"
-import { regions } from "./regions"
 import { orders } from "./orders"
 import { fulfillments } from "./fulfillments"
 import { reservations } from "./reservations"
@@ -45,7 +44,6 @@ export const client = {
   tags: tags,
   users: users,
   orders: orders,
-  regions: regions,
   taxes: taxes,
   invites: invites,
   inventoryItems: inventoryItems,

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

@@ -1,8 +1,4 @@
-import {
-  AdminCollectionsRes,
-  AdminProductsRes,
-  AdminRegionsRes,
-} from "@medusajs/medusa"
+import { AdminCollectionsRes, AdminProductsRes } from "@medusajs/medusa"
 import {
   AdminApiKeyResponse,
   AdminCustomerGroupResponse,
@@ -11,6 +7,7 @@ import {
   AdminTaxRegionResponse,
   SalesChannelDTO,
   UserDTO,
+  HttpTypes,
 } from "@medusajs/types"
 import { Outlet, RouteObject } from "react-router-dom"
 
@@ -593,7 +590,8 @@ export const RouteMap: RouteObject[] = [
                 path: ":id",
                 lazy: () => import("../../v2-routes/regions/region-detail"),
                 handle: {
-                  crumb: (data: AdminRegionsRes) => data.region.name,
+                  crumb: (data: { region: HttpTypes.AdminRegion }) =>
+                    data.region.name,
                 },
                 children: [
                   {

packages/admin-next/dashboard/src/types/api-payloads.ts

@@ -12,7 +12,6 @@ import {
   CreateProductCollectionDTO,
   CreatePromotionDTO,
   CreatePromotionRuleDTO,
-  CreateRegionDTO,
   CreateSalesChannelDTO,
   CreateServiceZoneDTO,
   CreateShippingOptionDTO,
@@ -26,7 +25,6 @@ import {
   UpdateProductCollectionDTO,
   UpdatePromotionDTO,
   UpdatePromotionRuleDTO,
-  UpdateRegionDTO,
   UpdateSalesChannelDTO,
   UpdateServiceZoneDTO,
   UpdateShippingOptionDTO,
@@ -38,10 +36,6 @@ import {
 // Auth
 export type EmailPassReq = { email: string; password: string }
 
-// Regions
-export type CreateRegionReq = CreateRegionDTO
-export type UpdateRegionReq = UpdateRegionDTO
-
 // Stores
 export type UpdateStoreReq = UpdateStoreDTO
 

packages/admin-next/dashboard/src/types/api-responses.ts

@@ -19,7 +19,6 @@ import {
   ProductTypeDTO,
   ProductVariantDTO,
   PromotionDTO,
-  RegionDTO,
   SalesChannelDTO,
   ShippingOptionDTO,
   ShippingProfileDTO,
@@ -69,11 +68,6 @@ export type ExtendedStoreDTO = StoreDTO & {
 export type StoreRes = { store: ExtendedStoreDTO }
 export type StoreListRes = { stores: ExtendedStoreDTO[] } & ListRes
 
-// Regions
-export type RegionRes = { region: RegionDTO }
-export type RegionListRes = { regions: RegionDTO[] } & ListRes
-export type RegionDeleteRes = DeleteRes
-
 // Fulfillments
 export type FulfillmentRes = { fulfillment: FulfillmentDTO }
 export type FulfillmentListRes = { fulfillments: FulfillmentDTO[] } & ListRes

packages/admin-next/dashboard/src/v2-routes/regions/region-add-countries/components/add-countries-form/add-countries-form.tsx

@@ -10,7 +10,6 @@ import { useTranslation } from "react-i18next"
 import * as zod from "zod"
 
 import { Button, Checkbox, toast } from "@medusajs/ui"
-import { RegionCountryDTO, RegionDTO } from "@medusajs/types"
 import {
   RouteFocusModal,
   useRouteModal,
@@ -22,9 +21,10 @@ import { useCountries } from "../../../common/hooks/use-countries"
 import { useCountryTableColumns } from "../../../common/hooks/use-country-table-columns"
 import { useCountryTableQuery } from "../../../common/hooks/use-country-table-query"
 import { useUpdateRegion } from "../../../../../hooks/api/regions"
+import { HttpTypes } from "@medusajs/types"
 
 type AddCountriesFormProps = {
-  region: RegionDTO
+  region: HttpTypes.AdminRegion
 }
 
 const AddCountriesSchema = zod.object({
@@ -71,7 +71,7 @@ export const AddCountriesForm = ({ region }: AddCountriesFormProps) => {
       iso_3: c.iso_3,
       num_code: c.num_code,
       region_id: null,
-      region: {} as RegionDTO,
+      region: {} as HttpTypes.AdminRegion,
     })),
     ...searchParams,
   })
@@ -102,7 +102,7 @@ export const AddCountriesForm = ({ region }: AddCountriesFormProps) => {
 
   const handleSubmit = form.handleSubmit(async (values) => {
     const payload = [
-      ...region.countries.map((c) => c.iso_2),
+      ...(region.countries?.map((c) => c.iso_2) ?? []),
       ...values.countries,
     ]
 
@@ -162,7 +162,7 @@ export const AddCountriesForm = ({ region }: AddCountriesFormProps) => {
   )
 }
 
-const columnHelper = createColumnHelper<RegionCountryDTO>()
+const columnHelper = createColumnHelper<HttpTypes.AdminRegionCountry>()
 
 const useColumns = () => {
   const base = useCountryTableColumns()
@@ -203,5 +203,5 @@ const useColumns = () => {
       ...base,
     ],
     [base]
-  ) as ColumnDef<RegionCountryDTO>[]
+  ) as ColumnDef<HttpTypes.AdminRegionCountry>[]
 }

packages/admin-next/dashboard/src/v2-routes/regions/region-detail/components/region-country-section/region-country-section.tsx

@@ -1,6 +1,5 @@
 import { PlusMini, Trash } from "@medusajs/icons"
 import { Checkbox, Container, Heading, toast, usePrompt } from "@medusajs/ui"
-import { RegionCountryDTO, RegionDTO } from "@medusajs/types"
 import {
   ColumnDef,
   RowSelectionState,
@@ -15,9 +14,10 @@ import { useCountries } from "../../../common/hooks/use-countries"
 import { useCountryTableColumns } from "../../../common/hooks/use-country-table-columns"
 import { useCountryTableQuery } from "../../../common/hooks/use-country-table-query"
 import { useUpdateRegion } from "../../../../../hooks/api/regions"
+import { HttpTypes } from "@medusajs/types"
 
 type RegionCountrySectionProps = {
-  region: RegionDTO
+  region: HttpTypes.AdminRegion
 }
 
 const PREFIX = "c"
@@ -143,8 +143,8 @@ const CountryActions = ({
   country,
   region,
 }: {
-  country: RegionCountryDTO
-  region: RegionDTO
+  country: HttpTypes.AdminRegionCountry
+  region: HttpTypes.AdminRegion
 }) => {
   const { t } = useTranslation()
   const prompt = usePrompt()
@@ -204,7 +204,7 @@ const CountryActions = ({
   )
 }
 
-const columnHelper = createColumnHelper<RegionCountryDTO>()
+const columnHelper = createColumnHelper<HttpTypes.AdminRegionCountry>()
 
 const useColumns = () => {
   const base = useCountryTableColumns()
@@ -243,12 +243,14 @@ const useColumns = () => {
       columnHelper.display({
         id: "actions",
         cell: ({ row, table }) => {
-          const { region } = table.options.meta as { region: RegionDTO }
+          const { region } = table.options.meta as {
+            region: HttpTypes.AdminRegion
+          }
 
           return <CountryActions country={row.original} region={region} />
         },
       }),
     ],
     [base]
-  ) as ColumnDef<RegionCountryDTO>[]
+  ) as ColumnDef<HttpTypes.AdminRegionCountry>[]
 }