Feat(medusa, medusa-js, medusa-react): Include sales channels in related queries as an optional expand parameter (#1816)

**What**
- Add `transformQuery` to get endpoints for product, order and cart
  - ensure that the default relations (when getting a singular entity) includes sales channels when enabled
- Add `EmptyQueryParams` class in common types to prevent query parameters while using `transformQuery`
- update product-, order- and cartFactory to include sales channels if provided
- remove `packages/medusa/src/controllers/products/admin-list-products.ts`

**Testing** 
- expands sales channel for single order
- expands sales channels for orders with expand parameter 
- returns single product with sales channel 
- expands sales channels for products with expand parameter
- returns cart with sales channel for single cart

Fixes CORE-293

Co-authored-by: Sebastian Rindom <7554214+srindom@users.noreply.github.com>
Co-authored-by: Adrien de Peretti <25098370+adrien2p@users.noreply.github.com>
This commit is contained in:
Philip Korsholm
2022-07-11 16:45:01 +00:00
committed by GitHub
co-authored by Sebastian Rindom Adrien de Peretti
parent fb4cfc3c3c
commit 19f35ba6aa
22 changed files with 510 additions and 255 deletions
@@ -11,6 +11,10 @@ import {
simpleLineItemFactory,
} from "./simple-line-item-factory"
import { RegionFactoryData, simpleRegionFactory } from "./simple-region-factory"
import {
SalesChannelFactoryData,
simpleSalesChannelFactory,
} from "./simple-sales-channel-factory"
import {
ShippingMethodFactoryData,
simpleShippingMethodFactory,
@@ -24,6 +28,7 @@ export type CartFactoryData = {
line_items?: LineItemFactoryData[]
shipping_address?: AddressFactoryData
shipping_methods?: ShippingMethodFactoryData[]
sales_channel?: SalesChannelFactoryData
}
export const simpleCartFactory = async (
@@ -62,6 +67,14 @@ export const simpleCartFactory = async (
const address = await simpleAddressFactory(connection, data.shipping_address)
let sales_channel
if (typeof data.sales_channel !== "undefined") {
sales_channel = await simpleSalesChannelFactory(
connection,
data.sales_channel
)
}
const id = data.id || `simple-cart-${Math.random() * 1000}`
const toSave = manager.create(Cart, {
id,
@@ -70,6 +83,7 @@ export const simpleCartFactory = async (
region_id: regionId,
customer_id: customerId,
shipping_address_id: address.id,
sales_channel_id: sales_channel?.id ?? null,
})
const cart = await manager.save(toSave)
@@ -79,7 +93,7 @@ export const simpleCartFactory = async (
await simpleShippingMethodFactory(connection, { ...sm, cart_id: id })
}
const items = data.line_items
const items = data.line_items || []
for (const item of items) {
await simpleLineItemFactory(connection, { ...item, cart_id: id })
}
@@ -6,7 +6,6 @@ import {
PaymentStatus,
FulfillmentStatus,
} from "@medusajs/medusa"
import {
DiscountFactoryData,
simpleDiscountFactory,
@@ -24,6 +23,10 @@ import {
ShippingMethodFactoryData,
simpleShippingMethodFactory,
} from "./simple-shipping-method-factory"
import {
SalesChannelFactoryData,
simpleSalesChannelFactory,
} from "./simple-sales-channel-factory"
export type OrderFactoryData = {
id?: string
@@ -37,6 +40,7 @@ export type OrderFactoryData = {
discounts?: DiscountFactoryData[]
shipping_address?: AddressFactoryData
shipping_methods?: ShippingMethodFactoryData[]
sales_channel?: SalesChannelFactoryData
}
export const simpleOrderFactory = async (
@@ -79,6 +83,14 @@ export const simpleOrderFactory = async (
)
}
let sales_channel
if (typeof data.sales_channel !== "undefined") {
sales_channel = await simpleSalesChannelFactory(
connection,
data.sales_channel
)
}
const id = data.id || `simple-order-${Math.random() * 1000}`
const toSave = manager.create(Order, {
id,
@@ -92,6 +104,7 @@ export const simpleOrderFactory = async (
currency_code: currencyCode,
tax_rate: taxRate,
shipping_address_id: address.id,
sales_channel_id: sales_channel?.id ?? null,
})
const order = await manager.save(toSave)
@@ -101,16 +114,17 @@ export const simpleOrderFactory = async (
await simpleShippingMethodFactory(connection, { ...sm, order_id: order.id })
}
const items = data.line_items.map((item) => {
let adjustments = item?.adjustments || []
return {
...item,
adjustments: adjustments.map((adj) => ({
...adj,
discount_id: discounts.find((d) => d.code === adj?.discount_code),
})),
}
})
const items =
data.line_items?.map((item) => {
const adjustments = item?.adjustments || []
return {
...item,
adjustments: adjustments.map((adj) => ({
...adj,
discount_id: discounts.find((d) => d.code === adj?.discount_code),
})),
}
}) || []
for (const item of items) {
await simpleLineItemFactory(connection, { ...item, order_id: id })
@@ -12,6 +12,10 @@ import {
ProductVariantFactoryData,
simpleProductVariantFactory,
} from "./simple-product-variant-factory"
import {
SalesChannelFactoryData,
simpleSalesChannelFactory,
} from "./simple-sales-channel-factory"
export type ProductFactoryData = {
id?: string
@@ -22,6 +26,7 @@ export type ProductFactoryData = {
tags?: string[]
options?: { id: string; title: string }[]
variants?: ProductVariantFactoryData[]
sales_channels?: SalesChannelFactoryData[]
}
export const simpleProductFactory = async (
@@ -43,6 +48,16 @@ export const simpleProductFactory = async (
type: ShippingProfileType.GIFT_CARD,
})
let sales_channels
if (data.sales_channels) {
sales_channels = await Promise.all(
data.sales_channels.map(
async (salesChannel) =>
await simpleSalesChannelFactory(connection, salesChannel)
)
)
}
const prodId = data.id || `simple-product-${Math.random() * 1000}`
const productToCreate = {
id: prodId,
@@ -77,6 +92,8 @@ export const simpleProductFactory = async (
const toSave = manager.create(Product, productToCreate)
toSave.sales_channels = sales_channels
await manager.save(toSave)
const optionId = `${prodId}-option`