asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

feat: Use tag ids instead of values wherever possible (#8394)

Browse Source
This commit is contained in:
Stevche Radevski
2024-08-02 09:22:03 +02:00
committed by GitHub
parent 71f0d24359
commit 3a068c6b27
26 changed files with 259 additions and 229 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/admin-next/dashboard/src/components/layout/notifications/notifications.tsx
+2 -2
View File
@@ -51,8 +51,8 @@ export const Notifications = () => {
}
}, [])
const handleOnOpen = (isOpen: boolean) => {
if (isOpen) {
const handleOnOpen = (shouldOpen: boolean) => {
if (shouldOpen) {
setHasUnread(false)
setOpen(true)
localStorage.setItem(LAST_READ_NOTIFICATION_KEY, new Date().toISOString())
packages/admin-next/dashboard/src/hooks/table/filters/use-product-table-filters.tsx
+1 -16
View File
@@ -95,7 +95,7 @@ export const useProductTableFilters = (
if (product_tags && !isProductTagExcluded) {
const tagFilter: Filter = {
key: "tags",
key: "tag_id",
label: t("fields.tag"),
type: "select",
multiple: true,
@@ -108,21 +108,6 @@ export const useProductTableFilters = (
filters = [...filters, tagFilter]
}
// if (product_tags) {
// const tagFilter: Filter = {
// key: "tags",
// label: t("fields.tag"),
// type: "select",
// multiple: true,
// options: product_tags.map((t) => ({
// label: t.value,
// value: t.id,
// })),
// }
// filters = [...filters, tagFilter]
// }
if (sales_channels) {
const salesChannelFilter: Filter = {
key: "sales_channel_id",
packages/admin-next/dashboard/src/hooks/table/query/use-product-table-query.tsx
+3 -3
View File
@@ -21,7 +21,7 @@ export const useProductTableQuery = ({
"category_id",
"collection_id",
"is_giftcard",
"tags",
"tag_id",
"type_id",
"status",
"id",
@@ -36,7 +36,7 @@ export const useProductTableQuery = ({
updated_at,
category_id,
collection_id,
tags,
tag_id,
type_id,
is_giftcard,
status,
@@ -54,7 +54,7 @@ export const useProductTableQuery = ({
collection_id: collection_id?.split(","),
is_giftcard: is_giftcard ? is_giftcard === "true" : undefined,
order: order,
tags: tags ? { value: tags.split(",") } : undefined,
tag_id: tag_id ? tag_id.split(",") : undefined,
type_id: type_id?.split(","),
status: status?.split(",") as HttpTypes.AdminProductStatus[],
q,
packages/admin-next/dashboard/src/routes/product-tags/product-tag-detail/components/product-tag-product-section/product-tag-product-section.tsx
+1 -1
View File
@@ -27,7 +27,7 @@ export const ProductTagProductSection = ({
const { products, count, isPending, isError, error } = useProducts({
...searchParams,
tags: productTag.id,
tag_id: productTag.id,
})
const filters = useProductTableFilters(["product_tags"])
packages/admin-next/dashboard/src/routes/products/product-create/utils.ts
+1 -1
View File
@@ -17,7 +17,7 @@ export const normalizeProductFormValues = (
status: values.status,
is_giftcard: false,
tags: values?.tags?.length
? values.tags?.map((tag) => ({ value: tag }))
? values.tags?.map((tag) => ({ id: tag }))
: undefined,
sales_channels: values?.sales_channels?.length
? values.sales_channels?.map((sc) => ({ id: sc.id }))
packages/admin-next/dashboard/src/routes/products/product-detail/components/product-organization-section/product-organization-section.tsx
+1 -1
View File
@@ -40,7 +40,7 @@ export const ProductOrganizationSection = ({
product.tags?.length
? product.tags.map((tag) => (
<Badge key={tag.id} className="w-fit" size="2xsmall" asChild>
<Link to={`/products?tags=${tag.id}`}>{tag.value}</Link>
<Link to={`/products?tag_id=${tag.id}`}>{tag.value}</Link>
</Badge>
))
: undefined
packages/admin-next/dashboard/src/routes/products/product-organization/components/product-organization-form/product-organization-form.tsx
+3 -3
View File
@@ -78,9 +78,9 @@ export const ProductOrganizationForm = ({
collection_id: data.collection_id || undefined,
categories: data.category_ids.map((id) => ({ id })) || undefined,
tags:
data.tag_ids?.map((t) => {
t
}) || undefined,
data.tag_ids?.map((t) => ({
id: t,
})) || undefined,
},
{
onSuccess: ({ product }) => {
packages/core/core-flows/src/product/helpers/normalize-for-import.ts
+21 -8
View File
@@ -1,10 +1,14 @@
import { ProductTypes } from "@medusajs/types"
import { HttpTypes, RegionTypes } from "@medusajs/types"
import { MedusaError, lowerCaseFirst } from "@medusajs/utils"
// We want to convert the csv data format to a standard DTO format.
export const normalizeForImport = (
rawProducts: object[],
regions: RegionTypes.RegionDTO[]
additional: {
regions: RegionTypes.RegionDTO[]
tags: ProductTypes.ProductTagDTO[]
}
): HttpTypes.AdminCreateProduct[] => {
const productMap = new Map<
string,
@@ -15,13 +19,16 @@ export const normalizeForImport = (
>()
// Currently region names are treated as case-insensitive.
const regionsMap = new Map(regions.map((r) => [r.name.toLowerCase(), r]))
const regionsMap = new Map(
additional.regions.map((r) => [r.name.toLowerCase(), r])
)
const tagsMap = new Map(additional.tags.map((t) => [t.value, t]))
rawProducts.forEach((rawProduct) => {
const productInMap = productMap.get(rawProduct["Product Handle"])
if (!productInMap) {
productMap.set(rawProduct["Product Handle"], {
product: normalizeProductForImport(rawProduct),
product: normalizeProductForImport(rawProduct, tagsMap),
variants: [normalizeVariantForImport(rawProduct, regionsMap)],
})
return
@@ -86,7 +93,8 @@ const booleanFields = [
]
const normalizeProductForImport = (
rawProduct: object
rawProduct: object,
tagsMap: Map<string, ProductTypes.ProductTagDTO>
): HttpTypes.AdminCreateProduct => {
const response = {}
@@ -108,10 +116,15 @@ const normalizeProductForImport = (
}
if (normalizedKey.startsWith("product_tag_")) {
response["tags"] = [
...(response["tags"] || []),
{ value: normalizedValue },
]
const tag = tagsMap.get(normalizedValue)
if (!tag) {
throw new MedusaError(
MedusaError.Types.INVALID_DATA,
`Tag with value ${normalizedValue} not found`
)
}
response["tags"] = [...(response["tags"] || []), { id: tag.id }]
return
}
packages/core/core-flows/src/product/steps/group-products-for-batch.ts
+5 -1
View File
@@ -38,9 +38,13 @@ export const groupProductsForBatchStep = createStep(
return acc
}
// New products will be created with a new ID, even if there is one present in the CSV.
// New products and variants will be created with a new ID, even if there is one present in the CSV.
// To add support for creating with predefined IDs we will need to do changes to the upsert method.
delete product.id
product.variants?.forEach((variant) => {
delete (variant as any).id
})
acc.toCreate.push(product)
return acc
},
packages/core/core-flows/src/product/steps/parse-product-csv.ts
+14 -5
View File
@@ -52,12 +52,21 @@ export const parseProductCsvStep = createStep(
}
})
const allRegions = await regionService.listRegions(
{},
{ select: ["id", "name", "currency_code"], take: null }
)
const [allRegions, allTags] = await Promise.all([
regionService.listRegions(
{},
{ select: ["id", "name", "currency_code"], take: null }
),
productService.listProductTags(
{},
{ select: ["id", "value"], take: null }
),
])
const normalizedData = normalizeForImport(v1Normalized, allRegions)
const normalizedData = normalizeForImport(v1Normalized, {
regions: allRegions,
tags: allTags,
})
return new StepResponse(normalizedData)
}
)
packages/core/types/src/http/product/admin/payloads.ts
+3 -3
View File
@@ -65,7 +65,7 @@ export interface AdminCreateProduct {
type_id?: string
collection_id?: string
categories?: { id: string }[]
tags?: { id?: string; value?: string }[]
tags?: { id: string }[]
options?: AdminCreateProductOption[]
variants?: AdminCreateProductVariant[]
sales_channels?: { id: string }[]
@@ -115,9 +115,9 @@ export interface AdminUpdateProduct {
type_id?: string | null
collection_id?: string | null
categories?: { id: string }[]
tags?: { id?: string; value?: string }[]
tags?: { id: string }[]
options?: AdminUpdateProductOption[]
variants?: AdminCreateProductVariant[]
variants?: (AdminCreateProductVariant | AdminUpdateProductVariant)[]
sales_channels?: { id: string }[]
weight?: number | null
length?: number | null
packages/core/types/src/product/common.ts
+7 -12
View File
@@ -702,25 +702,20 @@ export interface FilterableProductProps
*/
tags?: {
/**
* Values to filter product tags by.
* Filter a product by the IDs of their associated tags.
*/
value?: string[]
id?: string[]
}
/**
* Filters on a product's variant properties.
*/
variants?: {
options: { value: string; option_id: string }
options?: { value: string; option_id: string }
}
/**
* Filter a product by the ID of the associated type
*/
type_id?: string | string[]
/**
* @deprecated - Use `categories` instead
* Filter a product by the IDs of their associated categories.
*/
category_id?: string | string[] | OperatorMap<string>
/**
* Filter a product by the IDs of their associated categories.
*/
@@ -1417,9 +1412,9 @@ export interface CreateProductDTO {
*/
collection_id?: string
/**
* The associated tags to be created or updated.
* The tags to be associated with the product.
*/
tags?: UpsertProductTagDTO[]
tag_ids?: string[]
/**
* The product categories to associate with the product.
*/
@@ -1533,9 +1528,9 @@ export interface UpdateProductDTO {
*/
collection_id?: string | null
/**
* The associated tags to create or update.
* The tags to associate with the product
*/
tags?: UpsertProductTagDTO[]
tag_ids?: string[]
/**
* The product categories to associate with the product.
*/
packages/medusa/src/api/admin/products/validators.ts
+22 -24
View File
@@ -1,7 +1,10 @@
import { BatchMethodRequest } from "@medusajs/types"
import { ProductStatus } from "@medusajs/utils"
import { z } from "zod"
import { GetProductsParams } from "../../utils/common-validators"
import {
GetProductsParams,
transformProductParams,
} from "../../utils/common-validators"
import {
createFindParams,
createOperatorMap,
@@ -38,17 +41,19 @@ export type AdminGetProductsParamsType = z.infer<typeof AdminGetProductsParams>
export const AdminGetProductsParams = createFindParams({
offset: 0,
limit: 50,
}).merge(
z
.object({
variants: AdminGetProductVariantsParams.optional(),
price_list_id: z.string().array().optional(),
status: statusEnum.array().optional(),
$and: z.lazy(() => AdminGetProductsParams.array()).optional(),
$or: z.lazy(() => AdminGetProductsParams.array()).optional(),
})
.merge(GetProductsParams)
)
})
.merge(
z
.object({
variants: AdminGetProductVariantsParams.optional(),
price_list_id: z.string().array().optional(),
status: statusEnum.array().optional(),
$and: z.lazy(() => AdminGetProductsParams.array()).optional(),
$or: z.lazy(() => AdminGetProductsParams.array()).optional(),
})
.merge(GetProductsParams)
)
.transform(transformProductParams)
export type AdminGetProductOptionsParamsType = z.infer<
typeof AdminGetProductOptionsParams
@@ -195,7 +200,7 @@ export const AdminBatchUpdateProductVariant = AdminUpdateProductVariant.extend({
id: z.string(),
})
export const AdminCreateProductProductCategory = z.object({
export const IdAssociation = z.object({
id: z.string(),
})
@@ -213,8 +218,8 @@ export const AdminCreateProduct = z
status: statusEnum.nullish().default(ProductStatus.DRAFT),
type_id: z.string().nullish(),
collection_id: z.string().nullish(),
categories: z.array(AdminCreateProductProductCategory).optional(),
tags: z.array(AdminUpdateProductTag).optional(),
categories: z.array(IdAssociation).optional(),
tags: z.array(IdAssociation).optional(),
options: z.array(AdminCreateProductOption).optional(),
variants: z.array(AdminCreateProductVariant).optional(),
sales_channels: z.array(z.object({ id: z.string() })).optional(),
@@ -246,8 +251,8 @@ export const AdminUpdateProduct = z
handle: z.string().nullish(),
type_id: z.string().nullish(),
collection_id: z.string().nullish(),
categories: z.array(AdminCreateProductProductCategory).optional(),
tags: z.array(AdminUpdateProductTag).optional(),
categories: z.array(IdAssociation).optional(),
tags: z.array(IdAssociation).optional(),
sales_channels: z.array(z.object({ id: z.string() })).optional(),
weight: z.number().nullish(),
length: z.number().nullish(),
@@ -271,13 +276,6 @@ export const AdminBatchUpdateProduct = AdminUpdateProduct.extend({
export type AdminExportProductType = z.infer<typeof AdminExportProduct>
export const AdminExportProduct = z.object({})
// TODO: Handle in create and update product once ready
// @IsOptional()
// @Type(() => ProductProductCategoryReq)
// @ValidateNested({ each: true })
// @IsArray()
// categories?: ProductProductCategoryReq[]
export const AdminCreateVariantInventoryItem = z.object({
required_quantity: z.number(),
inventory_item_id: z.string(),
packages/medusa/src/api/store/products/validators.ts
+27 -24
View File
@@ -2,6 +2,7 @@ import { z } from "zod"
import {
GetProductsParams,
ProductStatusEnum,
transformProductParams,
} from "../../utils/common-validators"
import {
createFindParams,
@@ -45,28 +46,30 @@ export type StoreGetProductsParamsType = z.infer<typeof StoreGetProductsParams>
export const StoreGetProductsParams = createFindParams({
offset: 0,
limit: 50,
}).merge(
z
.object({
// These are used to populate the tax and pricing context
region_id: z.string().optional(),
country_code: z.string().optional(),
province: z.string().optional(),
cart_id: z.string().optional(),
})
.merge(
z
.object({
// These are used to populate the tax and pricing context
region_id: z.string().optional(),
country_code: z.string().optional(),
province: z.string().optional(),
cart_id: z.string().optional(),
variants: z
.object({
status: ProductStatusEnum.array().optional(),
options: z
.object({ value: z.string(), option_id: z.string() })
.optional(),
$and: z.lazy(() => StoreGetProductsParams.array()).optional(),
$or: z.lazy(() => StoreGetProductsParams.array()).optional(),
})
.optional(),
$and: z.lazy(() => StoreGetProductsParams.array()).optional(),
$or: z.lazy(() => StoreGetProductsParams.array()).optional(),
})
.merge(GetProductsParams)
.strict()
)
variants: z
.object({
status: ProductStatusEnum.array().optional(),
options: z
.object({ value: z.string(), option_id: z.string() })
.optional(),
$and: z.lazy(() => StoreGetProductsParams.array()).optional(),
$or: z.lazy(() => StoreGetProductsParams.array()).optional(),
})
.optional(),
$and: z.lazy(() => StoreGetProductsParams.array()).optional(),
$or: z.lazy(() => StoreGetProductsParams.array()).optional(),
})
.merge(GetProductsParams)
.strict()
)
.transform(transformProductParams)
packages/medusa/src/api/utils/common-validators/products/index.ts
+43 -6
View File
@@ -2,21 +2,58 @@ import { ProductStatus } from "@medusajs/utils"
import { z } from "zod"
import { createOperatorMap } from "../../validators"
import { OptionalBooleanValidator } from "../common"
import { FilterableProductProps } from "@medusajs/types"
export const ProductStatusEnum = z.nativeEnum(ProductStatus)
export const GetProductsParams = z.object({
q: z.string().optional(),
id: z.union([z.string(), z.array(z.string())]).optional(),
title: z.string().nullish(),
handle: z.string().nullish(),
title: z.string().optional(),
handle: z.string().optional(),
is_giftcard: OptionalBooleanValidator,
category_id: z.union([z.string(), z.array(z.string())]).nullish(),
sales_channel_id: z.union([z.string(), z.array(z.string())]).nullish(),
collection_id: z.union([z.string(), z.array(z.string())]).nullish(),
tags: z.union([z.string(), z.array(z.string())]).optional(),
category_id: z.union([z.string(), z.array(z.string())]).optional(),
sales_channel_id: z.union([z.string(), z.array(z.string())]).optional(),
collection_id: z.union([z.string(), z.array(z.string())]).optional(),
tag_id: z.union([z.string(), z.array(z.string())]).optional(),
type_id: z.union([z.string(), z.array(z.string())]).optional(),
created_at: createOperatorMap().optional(),
updated_at: createOperatorMap().optional(),
deleted_at: createOperatorMap().optional(),
})
type HttpProductFilters = FilterableProductProps & {
tag_id?: string | string[]
category_id?: string | string[]
}
export const transformProductParams = (
data: HttpProductFilters
): FilterableProductProps => {
const res = {
...data,
tags: normalizeArray(data, "tag_id"),
categories: normalizeArray(data, "category_id"),
}
delete res.tag_id
delete res.category_id
return res as FilterableProductProps
}
const normalizeArray = (filters: HttpProductFilters, key: string) => {
if (filters[key]) {
if (Array.isArray(filters[key])) {
return {
id: { $in: filters[key] },
}
} else {
return {
id: filters[key] as string,
}
}
}
return undefined
}
packages/modules/product/integration-tests/__tests__/product-module-service/products.spec.ts
+14 -3
View File
@@ -1,4 +1,8 @@
import { IProductModuleService, ProductCategoryDTO } from "@medusajs/types"
import {
IProductModuleService,
ProductCategoryDTO,
ProductTagDTO,
} from "@medusajs/types"
import { kebabCase, Modules, ProductStatus } from "@medusajs/utils"
import {
Product,
@@ -104,6 +108,11 @@ moduleIntegrationTestRunner<IProductModuleService>({
categories.push(await service.createProductCategories(entry))
}
const tags: ProductTagDTO[] = []
for (const entry of tagsData) {
tags.push(await service.createProductTags(entry))
}
productCategoryOne = categories[0]
productCategoryTwo = categories[1]
@@ -125,7 +134,7 @@ moduleIntegrationTestRunner<IProductModuleService>({
status: ProductStatus.PUBLISHED,
categories: [{ id: productCategoryOne.id }],
collection_id: productCollectionOne.id,
tags: tagsData,
tags: [{ id: tags[0].id }],
options: [
{
title: "size",
@@ -437,6 +446,8 @@ moduleIntegrationTestRunner<IProductModuleService>({
value: "tag 2",
}
await service.createProductTags(newTagData)
const updateData = {
id: productTwo.id,
categories: [
@@ -446,7 +457,7 @@ moduleIntegrationTestRunner<IProductModuleService>({
],
collection_id: productCollectionTwo.id,
type_id: productTypeTwo.id,
tags: [newTagData],
tags: [{ id: newTagData.id }],
}
await service.upsertProducts([updateData])
packages/modules/product/src/services/index.ts
-1
View File
@@ -1,3 +1,2 @@
export { default as ProductService } from "./product"
export { default as ProductCategoryService } from "./product-category"
export { default as ProductModuleService } from "./product-module-service"
packages/modules/product/src/services/product-module-service.ts
+10 -23
View File
@@ -18,7 +18,7 @@ import {
ProductType,
ProductVariant,
} from "@models"
import { ProductCategoryService, ProductService } from "@services"
import { ProductCategoryService } from "@services"
import {
arrayDifference,
@@ -55,7 +55,7 @@ import { joinerConfig } from "./../joiner-config"
type InjectedDependencies = {
baseRepository: DAL.RepositoryService
productService: ProductService
productService: ModulesSdkTypes.IMedusaInternalService<any, any>
productVariantService: ModulesSdkTypes.IMedusaInternalService<any, any>
productTagService: ModulesSdkTypes.IMedusaInternalService<any>
productCategoryService: ProductCategoryService
@@ -102,7 +102,7 @@ export default class ProductModuleService
implements ProductTypes.IProductModuleService
{
protected baseRepository_: DAL.RepositoryService
protected readonly productService_: ProductService
protected readonly productService_: ModulesSdkTypes.IMedusaInternalService<Product>
protected readonly productVariantService_: ModulesSdkTypes.IMedusaInternalService<ProductVariant>
protected readonly productCategoryService_: ProductCategoryService
protected readonly productTagService_: ModulesSdkTypes.IMedusaInternalService<ProductTag>
@@ -1609,26 +1609,6 @@ export default class ProductModuleService
productData.discountable = false
}
if (productData.tags?.length && productData.tags.some((t) => !t.id)) {
const dbTags = await this.productTagService_.list(
{
value: productData.tags
.map((t) => t.value)
.filter((v) => !!v) as string[],
},
{ take: null },
sharedContext
)
productData.tags = productData.tags.map((tag) => {
const dbTag = dbTags.find((t) => t.value === tag.value)
return {
...tag,
...(dbTag ? { id: dbTag.id } : {}),
}
})
}
if (productData.options?.length) {
const dbOptions = await this.productOptionService_.list(
{ product_id: productData.id },
@@ -1652,6 +1632,13 @@ export default class ProductModuleService
})
}
if (productData.tag_ids) {
;(productData as any).tags = productData.tag_ids.map((cid) => ({
id: cid,
}))
delete productData.tag_ids
}
if (productData.category_ids) {
;(productData as any).categories = productData.category_ids.map(
(cid) => ({
packages/modules/product/src/services/product.ts
-80
View File
@@ -1,80 +0,0 @@
import {
Context,
DAL,
FilterableProductProps,
FindConfig,
ProductTypes,
} from "@medusajs/types"
import { InjectManager, MedusaContext, ModulesSdkUtils } from "@medusajs/utils"
import { Product } from "@models"
type InjectedDependencies = {
productRepository: DAL.RepositoryService
}
type NormalizedFilterableProductProps = ProductTypes.FilterableProductProps & {
categories?: {
id: string | { $in: string[] }
}
}
export default class ProductService extends ModulesSdkUtils.MedusaInternalService<
InjectedDependencies,
Product
>(Product) {
protected readonly productRepository_: DAL.RepositoryService<Product>
constructor({ productRepository }: InjectedDependencies) {
// @ts-ignore
// eslint-disable-next-line prefer-rest-params
super(...arguments)
this.productRepository_ = productRepository
}
@InjectManager("productRepository_")
async list(
filters: ProductTypes.FilterableProductProps = {},
config: FindConfig<Product> = {},
@MedusaContext() sharedContext: Context = {}
): Promise<Product[]> {
return await super.list(
ProductService.normalizeFilters(filters),
config,
sharedContext
)
}
@InjectManager("productRepository_")
async listAndCount(
filters: ProductTypes.FilterableProductProps = {},
config: FindConfig<any> = {},
@MedusaContext() sharedContext: Context = {}
): Promise<[Product[], number]> {
return await super.listAndCount(
ProductService.normalizeFilters(filters),
config,
sharedContext
)
}
protected static normalizeFilters(
filters: FilterableProductProps = {}
): NormalizedFilterableProductProps {
const normalized = filters as NormalizedFilterableProductProps
if (normalized.category_id) {
if (Array.isArray(normalized.category_id)) {
normalized.categories = {
id: { $in: normalized.category_id },
}
} else {
normalized.categories = {
id: normalized.category_id as string,
}
}
delete normalized.category_id
}
return normalized
}
}