feat(medusa-js, medusa-react, medusa): Prepare API for admin implementations (#3110)

********What********
Add `joinSalesChannels util to stock locations

Add the following endpoints to medusa-react
- inventory items
    - mutations
        - update
        - delete
        - update location level
        - delete location level
        - create location level
    - queries
        - list inventory items
        - get inventory item
        - list location levels
- Stock locations
    - mutations
        - create stock location
        - update stock location
        - delete stock location
    - queries
        - list stock locations
        - get stock locatoin
- Variants
    - queries
        - get inventory
- Reservations
    - mutations
        - create reservation
        - update reservation
        - delete reservation
    - queries
        - list reservations
        - get reservation
- sales channels 
  - mutations
    - associate location with sc
    - remove location association

**Why**
- Update clients to reflect new api endpoints in the core with inventory modules

Co-authored-by: Philip Korsholm <88927411+pKorsholm@users.noreply.github.com>

packages/medusa-react/src/hooks/admin/index.ts

@@ -8,6 +8,7 @@ export * from "./customers"
 export * from "./discounts"
 export * from "./draft-orders"
 export * from "./gift-cards"
+export * from "./inventory-item"
 export * from "./invites"
 export * from "./notes"
 export * from "./notifications"
@@ -21,6 +22,7 @@ export * from "./publishable-api-keys"
 export * from "./regions"
 export * from "./return-reasons"
 export * from "./returns"
+export * from "./reservations"
 export * from "./sales-channels"
 export * from "./shipping-options"
 export * from "./shipping-profiles"
@@ -32,3 +34,4 @@ export * from "./users"
 export * from "./variants"
 export * from "./payment-collections"
 export * from "./payments"
+export * from "./stock-locations"

packages/medusa-react/src/hooks/admin/inventory-item/index.ts

@@ -0,0 +1,2 @@
+export * from "./queries"
+export * from "./mutations"

packages/medusa-react/src/hooks/admin/inventory-item/mutations.ts

@@ -0,0 +1,151 @@
+import {
+  AdminInventoryItemsDeleteRes,
+  AdminInventoryItemsRes,
+  AdminPostInventoryItemsInventoryItemReq,
+  AdminPostInventoryItemsItemLocationLevelsLevelReq,
+  AdminPostInventoryItemsItemLocationLevelsReq,
+} from "@medusajs/medusa"
+import { Response } from "@medusajs/medusa-js"
+import {
+  useMutation,
+  UseMutationOptions,
+  useQueryClient,
+} from "@tanstack/react-query"
+import { useMedusa } from "../../../contexts"
+import { buildOptions } from "../../utils/buildOptions"
+import { adminInventoryItemsKeys } from "./queries"
+
+// inventory item
+
+// update inventory item
+export const useAdminUpdateInventoryItem = (
+  inventoryItemId: string,
+  options?: UseMutationOptions<
+    Response<AdminInventoryItemsRes>,
+    Error,
+    AdminPostInventoryItemsInventoryItemReq
+  >
+) => {
+  const { client } = useMedusa()
+  const queryClient = useQueryClient()
+
+  return useMutation(
+    (payload: AdminPostInventoryItemsInventoryItemReq) =>
+      client.admin.inventoryItems.update(inventoryItemId, payload),
+    buildOptions(
+      queryClient,
+      [adminInventoryItemsKeys.detail(inventoryItemId)],
+      options
+    )
+  )
+}
+
+// delete inventory item
+export const useAdminDeleteInventoryItem = (
+  inventoryItemId: string,
+  options?: UseMutationOptions<
+    Response<AdminInventoryItemsDeleteRes>,
+    Error,
+    void
+  >
+) => {
+  const { client } = useMedusa()
+  const queryClient = useQueryClient()
+
+  return useMutation(
+    () => client.admin.inventoryItems.delete(inventoryItemId),
+    buildOptions(
+      queryClient,
+      [adminInventoryItemsKeys.detail(inventoryItemId)],
+      options
+    )
+  )
+}
+
+// location level
+export const useAdminUpdateLocationLevel = (
+  inventoryItemId: string,
+  options?: UseMutationOptions<
+    Response<AdminInventoryItemsRes>,
+    Error,
+    AdminPostInventoryItemsItemLocationLevelsLevelReq & {
+      stockLocationId: string
+    }
+  >
+) => {
+  const { client } = useMedusa()
+  const queryClient = useQueryClient()
+
+  return useMutation(
+    (
+      payload: AdminPostInventoryItemsItemLocationLevelsLevelReq & {
+        stockLocationId: string
+      }
+    ) =>
+      client.admin.inventoryItems.updateLocationLevel(
+        inventoryItemId,
+        payload.stockLocationId,
+        {
+          incoming_quantity: payload.incoming_quantity,
+          stocked_quantity: payload.stocked_quantity,
+        }
+      ),
+    buildOptions(
+      queryClient,
+      [
+        adminInventoryItemsKeys.detail(inventoryItemId),
+        adminInventoryItemsKeys.lists(),
+      ],
+      options
+    )
+  )
+}
+
+export const useAdminDeleteLocationLevel = (
+  inventoryItemId: string,
+  options?: UseMutationOptions<Response<AdminInventoryItemsRes>, Error, string>
+) => {
+  const { client } = useMedusa()
+  const queryClient = useQueryClient()
+
+  return useMutation(
+    (stockLocationId: string) =>
+      client.admin.inventoryItems.deleteLocationLevel(
+        inventoryItemId,
+        stockLocationId
+      ),
+    buildOptions(
+      queryClient,
+      [
+        adminInventoryItemsKeys.detail(inventoryItemId),
+        adminInventoryItemsKeys.lists(),
+      ],
+      options
+    )
+  )
+}
+
+export const useAdminCreateLocationLevel = (
+  inventoryItemId: string,
+  options?: UseMutationOptions<
+    Response<AdminInventoryItemsRes>,
+    Error,
+    AdminPostInventoryItemsItemLocationLevelsReq
+  >
+) => {
+  const { client } = useMedusa()
+  const queryClient = useQueryClient()
+
+  return useMutation(
+    (payload: AdminPostInventoryItemsItemLocationLevelsReq) =>
+      client.admin.inventoryItems.createLocationLevel(inventoryItemId, payload),
+    buildOptions(
+      queryClient,
+      [
+        adminInventoryItemsKeys.detail(inventoryItemId),
+        adminInventoryItemsKeys.lists(),
+      ],
+      options
+    )
+  )
+}

packages/medusa-react/src/hooks/admin/inventory-item/queries.ts

@@ -0,0 +1,79 @@
+import {
+  AdminGetStockLocationsParams,
+  AdminInventoryItemsListWithVariantsAndLocationLevelsRes,
+  AdminInventoryItemsLocationLevelsRes,
+  AdminInventoryItemsRes,
+} from "@medusajs/medusa"
+import { Response } from "@medusajs/medusa-js"
+import { useQuery } from "@tanstack/react-query"
+import { useMedusa } from "../../../contexts"
+import { UseQueryOptionsWrapper } from "../../../types"
+import { queryKeysFactory } from "../../utils"
+
+const ADMIN_INVENTORY_ITEMS_QUERY_KEY = `admin_inventory_items` as const
+
+export const adminInventoryItemsKeys = queryKeysFactory(
+  ADMIN_INVENTORY_ITEMS_QUERY_KEY
+)
+
+type InventoryItemsQueryKeys = typeof adminInventoryItemsKeys
+
+export const useAdminInventoryItems = (
+  query?: AdminGetStockLocationsParams,
+  options?: UseQueryOptionsWrapper<
+    Response<AdminInventoryItemsListWithVariantsAndLocationLevelsRes>,
+    Error,
+    ReturnType<InventoryItemsQueryKeys["list"]>
+  >
+) => {
+  const { client } = useMedusa()
+
+  const { data, ...rest } = useQuery(
+    adminInventoryItemsKeys.list(query),
+    () => client.admin.inventoryItems.list(query),
+    { ...options }
+  )
+
+  return { ...data, ...rest } as const
+}
+
+export const useAdminInventoryItem = (
+  inventoryItemId: string,
+  query?: AdminGetStockLocationsParams,
+  options?: UseQueryOptionsWrapper<
+    Response<AdminInventoryItemsRes>,
+    Error,
+    ReturnType<InventoryItemsQueryKeys["detail"]>
+  >
+) => {
+  const { client } = useMedusa()
+
+  const { data, ...rest } = useQuery(
+    adminInventoryItemsKeys.detail(inventoryItemId),
+    () => client.admin.inventoryItems.retrieve(inventoryItemId, query),
+    { ...options }
+  )
+
+  return { ...data, ...rest } as const
+}
+
+export const useAdminInventoryItemLocationLevels = (
+  inventoryItemId: string,
+  query?: AdminGetStockLocationsParams,
+  options?: UseQueryOptionsWrapper<
+    Response<AdminInventoryItemsLocationLevelsRes>,
+    Error,
+    ReturnType<InventoryItemsQueryKeys["detail"]>
+  >
+) => {
+  const { client } = useMedusa()
+
+  const { data, ...rest } = useQuery(
+    adminInventoryItemsKeys.detail(inventoryItemId),
+    () =>
+      client.admin.inventoryItems.listLocationLevels(inventoryItemId, query),
+    { ...options }
+  )
+
+  return { ...data, ...rest } as const
+}

packages/medusa-react/src/hooks/admin/reservations/index.ts

@@ -0,0 +1,2 @@
+export * from "./mutations"
+export * from "./queries"

packages/medusa-react/src/hooks/admin/reservations/mutations.ts

@@ -0,0 +1,75 @@
+import {
+  AdminPostReservationsReq,
+  AdminPostReservationsReservationReq,
+  AdminReservationsDeleteRes,
+  AdminReservationsRes,
+} from "@medusajs/medusa"
+import { Response } from "@medusajs/medusa-js/src"
+import {
+  useMutation,
+  UseMutationOptions,
+  useQueryClient,
+} from "@tanstack/react-query"
+import { useMedusa } from "../../../contexts"
+import { buildOptions } from "../../utils/buildOptions"
+import { adminReservationsKeys } from "./queries"
+
+export const useAdminCreateReservation = (
+  options?: UseMutationOptions<
+    Response<AdminReservationsRes>,
+    Error,
+    AdminPostReservationsReq
+  >
+) => {
+  const { client } = useMedusa()
+  const queryClient = useQueryClient()
+
+  return useMutation(
+    (payload: AdminPostReservationsReq) =>
+      client.admin.reservations.create(payload),
+    buildOptions(queryClient, [adminReservationsKeys.list()], options)
+  )
+}
+
+export const useAdminUpdateReservation = (
+  id: string,
+  options?: UseMutationOptions<
+    Response<AdminReservationsRes>,
+    Error,
+    AdminPostReservationsReq
+  >
+) => {
+  const { client } = useMedusa()
+  const queryClient = useQueryClient()
+
+  return useMutation(
+    (payload: AdminPostReservationsReservationReq) =>
+      client.admin.reservations.update(id, payload),
+    buildOptions(
+      queryClient,
+      [adminReservationsKeys.lists(), adminReservationsKeys.detail(id)],
+      options
+    )
+  )
+}
+
+export const useAdminDeleteReservation = (
+  id: string,
+  options?: UseMutationOptions<
+    Response<AdminReservationsDeleteRes>,
+    Error,
+    void
+  >
+) => {
+  const { client } = useMedusa()
+  const queryClient = useQueryClient()
+
+  return useMutation(
+    () => client.admin.reservations.delete(id),
+    buildOptions(
+      queryClient,
+      [adminReservationsKeys.lists(), adminReservationsKeys.detail(id)],
+      options
+    )
+  )
+}

packages/medusa-react/src/hooks/admin/reservations/queries.ts

@@ -0,0 +1,56 @@
+import {
+  AdminGetReservationsParams,
+  AdminReservationsListRes,
+  AdminReservationsRes,
+} from "@medusajs/medusa"
+import { Response } from "@medusajs/medusa-js"
+import { useQuery } from "@tanstack/react-query"
+import { useMedusa } from "../../../contexts"
+import { UseQueryOptionsWrapper } from "../../../types"
+import { queryKeysFactory } from "../../utils"
+
+const ADMIN_RESERVATIONS_QUERY_KEY = `admin_stock_locations` as const
+
+export const adminReservationsKeys = queryKeysFactory(
+  ADMIN_RESERVATIONS_QUERY_KEY
+)
+
+type ReservationsQueryKeys = typeof adminReservationsKeys
+
+export const useAdminReservations = (
+  query?: AdminGetReservationsParams,
+  options?: UseQueryOptionsWrapper<
+    Response<AdminReservationsListRes>,
+    Error,
+    ReturnType<ReservationsQueryKeys["list"]>
+  >
+) => {
+  const { client } = useMedusa()
+
+  const { data, ...rest } = useQuery(
+    adminReservationsKeys.list(query),
+    () => client.admin.reservations.list(query),
+    { ...options }
+  )
+
+  return { ...data, ...rest } as const
+}
+
+export const useAdminReservation = (
+  id: string,
+  options?: UseQueryOptionsWrapper<
+    Response<AdminReservationsRes>,
+    Error,
+    ReturnType<ReservationsQueryKeys["detail"]>
+  >
+) => {
+  const { client } = useMedusa()
+
+  const { data, ...rest } = useQuery(
+    adminReservationsKeys.detail(id),
+    () => client.admin.reservations.retrieve(id),
+    options
+  )
+
+  return { ...data, ...rest } as const
+}

packages/medusa-react/src/hooks/admin/sales-channels/mutations.ts

@@ -16,6 +16,7 @@ import {
 import { useMedusa } from "../../../contexts"
 import { buildOptions } from "../../utils/buildOptions"
 import { adminProductKeys } from "../products"
+import { adminStockLocationsKeys } from "../stock-locations"
 import { adminSalesChannelsKeys } from "./queries"
 
 /**
@@ -162,3 +163,73 @@ export const useAdminAddProductsToSalesChannel = (
     )
   )
 }
+
+/**
+ * Add a location to a sales channel
+ * @experimental This feature is under development and may change in the future.
+ * To use this feature please install the stock location in your medusa backend project.
+ * @description Add a location to a sales channel
+ * @param options
+ */
+export const useAdminAddLocationToSalesChannel = (
+  options?: UseMutationOptions<
+    Response<AdminSalesChannelsRes>,
+    Error,
+    {
+      sales_channel_id: string
+      location_id: string
+    }
+  >
+) => {
+  const { client } = useMedusa()
+  const queryClient = useQueryClient()
+  return useMutation(({ sales_channel_id, location_id }) => {
+    return client.admin.salesChannels.addLocation(sales_channel_id, {
+      location_id,
+    })
+  }, buildOptions(
+    queryClient, 
+    [
+      adminSalesChannelsKeys.lists(), 
+      adminSalesChannelsKeys.details(), 
+      adminStockLocationsKeys.all
+    ], 
+    options
+    )
+  )
+}
+
+/**
+ * Remove a location from a sales channel
+ * @experimental This feature is under development and may change in the future.
+ * To use this feature please install the stock location in your medusa backend project.
+ * @description Remove a location from a sales channel
+ * @param options
+ */
+export const useAdminRemoveLocationFromSalesChannel = (
+  options?: UseMutationOptions<
+    Response<AdminSalesChannelsRes>,
+    Error,
+    {
+      sales_channel_id: string
+      location_id: string
+    }
+  >
+) => {
+  const { client } = useMedusa()
+  const queryClient = useQueryClient()
+  return useMutation(({ sales_channel_id, location_id }) => {
+    return client.admin.salesChannels.removeLocation(sales_channel_id, {
+      location_id,
+    })
+  }, buildOptions(
+    queryClient, 
+    [
+      adminSalesChannelsKeys.lists(), 
+      adminSalesChannelsKeys.details(), 
+      adminStockLocationsKeys.all
+    ], 
+    options
+    )
+  )
+}

packages/medusa-react/src/hooks/admin/stock-locations/index.ts

@@ -0,0 +1,2 @@
+export * from "./queries"
+export * from "./mutations"

packages/medusa-react/src/hooks/admin/stock-locations/mutations.ts

@@ -0,0 +1,74 @@
+import {
+  AdminPostStockLocationsReq,
+  AdminStockLocationsDeleteRes,
+  AdminStockLocationsRes,
+} from "@medusajs/medusa"
+import { Response } from "@medusajs/medusa-js"
+import {
+  useMutation,
+  UseMutationOptions,
+  useQueryClient,
+} from "@tanstack/react-query"
+import { useMedusa } from "../../../contexts"
+import { buildOptions } from "../../utils/buildOptions"
+import { adminStockLocationsKeys } from "./queries"
+
+export const useAdminCreateStockLocation = (
+  options?: UseMutationOptions<
+    Response<AdminStockLocationsRes>,
+    Error,
+    AdminPostStockLocationsReq
+  >
+) => {
+  const { client } = useMedusa()
+  const queryClient = useQueryClient()
+
+  return useMutation(
+    (payload: AdminPostStockLocationsReq) =>
+      client.admin.stockLocations.create(payload),
+    buildOptions(queryClient, [adminStockLocationsKeys.lists()], options)
+  )
+}
+
+export const useAdminUpdateStockLocation = (
+  id: string,
+  options?: UseMutationOptions<
+    Response<AdminStockLocationsRes>,
+    Error,
+    AdminPostStockLocationsReq
+  >
+) => {
+  const { client } = useMedusa()
+  const queryClient = useQueryClient()
+
+  return useMutation(
+    (payload: AdminPostStockLocationsReq) =>
+      client.admin.stockLocations.update(id, payload),
+    buildOptions(
+      queryClient,
+      [adminStockLocationsKeys.lists(), adminStockLocationsKeys.detail(id)],
+      options
+    )
+  )
+}
+
+export const useAdminDeleteStockLocation = (
+  id: string,
+  options?: UseMutationOptions<
+    Response<AdminStockLocationsDeleteRes>,
+    Error,
+    void
+  >
+) => {
+  const { client } = useMedusa()
+  const queryClient = useQueryClient()
+
+  return useMutation(
+    () => client.admin.stockLocations.delete(id),
+    buildOptions(
+      queryClient,
+      [adminStockLocationsKeys.lists(), adminStockLocationsKeys.detail(id)],
+      options
+    )
+  )
+}

packages/medusa-react/src/hooks/admin/stock-locations/queries.ts

@@ -0,0 +1,56 @@
+import {
+  AdminGetStockLocationsParams,
+  AdminStockLocationsListRes,
+  AdminStockLocationsRes,
+} from "@medusajs/medusa"
+import { Response } from "@medusajs/medusa-js"
+import { useQuery } from "@tanstack/react-query"
+import { useMedusa } from "../../../contexts"
+import { UseQueryOptionsWrapper } from "../../../types"
+import { queryKeysFactory } from "../../utils"
+
+const ADMIN_STOCK_LOCATIONS_QUERY_KEY = `admin_stock_locations` as const
+
+export const adminStockLocationsKeys = queryKeysFactory(
+  ADMIN_STOCK_LOCATIONS_QUERY_KEY
+)
+
+type StockLocationsQueryKeys = typeof adminStockLocationsKeys
+
+export const useAdminStockLocations = (
+  query?: AdminGetStockLocationsParams,
+  options?: UseQueryOptionsWrapper<
+    Response<AdminStockLocationsListRes>,
+    Error,
+    ReturnType<StockLocationsQueryKeys["list"]>
+  >
+) => {
+  const { client } = useMedusa()
+
+  const { data, ...rest } = useQuery(
+    adminStockLocationsKeys.list(query),
+    () => client.admin.stockLocations.list(query),
+    options
+  )
+
+  return { ...data, ...rest } as const
+}
+
+export const useAdminStockLocation = (
+  id: string,
+  options?: UseQueryOptionsWrapper<
+    Response<AdminStockLocationsRes>,
+    Error,
+    ReturnType<StockLocationsQueryKeys["detail"]>
+  >
+) => {
+  const { client } = useMedusa()
+
+  const { data, ...rest } = useQuery(
+    adminStockLocationsKeys.detail(id),
+    () => client.admin.stockLocations.retrieve(id),
+    options
+  )
+
+  return { ...data, ...rest } as const
+}

packages/medusa-react/src/hooks/admin/variants/queries.ts

@@ -1,4 +1,8 @@
-import { AdminGetVariantsParams, AdminVariantsListRes } from "@medusajs/medusa"
+import {
+  AdminGetVariantsParams,
+  AdminGetVariantsVariantInventoryRes,
+  AdminVariantsListRes,
+} from "@medusajs/medusa"
 import { Response } from "@medusajs/medusa-js"
 import { useQuery } from "@tanstack/react-query"
 import { useMedusa } from "../../../contexts"
@@ -27,3 +31,20 @@ export const useAdminVariants = (
   )
   return { ...data, ...rest } as const
 }
+
+export const useAdminVariantsInventory = (
+  id: string,
+  options?: UseQueryOptionsWrapper<
+    Response<AdminGetVariantsVariantInventoryRes>,
+    Error,
+    ReturnType<VariantQueryKeys["detail"]>
+  >
+) => {
+  const { client } = useMedusa()
+  const { data, ...rest } = useQuery(
+    adminVariantKeys.detail(id),
+    () => client.admin.variants.getInventory(id),
+    options
+  )
+  return { ...data, ...rest } as const
+}