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

fix: relationships to accept ids (#11399)

Browse Source
This commit is contained in:
Harminder Virk
2025-02-14 11:11:36 +05:30
committed by GitHub
parent a88f6576bd
commit d1cbe4c61e
4 changed files with 101 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
.changeset/great-badgers-play.md Normal file
View File

@@ -0,0 +1,6 @@
---
"@medusajs/types": patch
"@medusajs/utils": patch
---
fix: relationships to accept ids

28
packages/core/types/src/dml/index.ts
View File

@@ -213,6 +213,27 @@ export type InferSchemaFields<Schema extends DMLSchema> = Prettify<
} & InferForeignKeys<Schema>
>
/**
* Infers the types of the schema fields from the DML entity
* for module services
*/
export type InferSchemaFieldsForModuleServices<Schema extends DMLSchema> =
Prettify<
{
[K in keyof Schema]: Schema[K] extends RelationshipType<any>
? Schema[K]["type"] extends "belongsTo"
? string
: Schema[K]["type"] extends "hasOne" | "hasOneWithFK"
? string
: Schema[K]["type"] extends "hasMany"
? string[]
: Schema[K]["type"] extends "manyToMany"
? string[]
: never
: Schema[K]["$dataType"]
} & InferForeignKeys<Schema>
>
/**
* Infers the schema properties without the relationships
*/
@@ -247,6 +268,13 @@ export type Infer<T> = T extends IDmlEntity<infer Schema, any>
? EntityConstructor<InferSchemaFields<Schema>>
: never
export type InferEntityForModuleService<T> = T extends IDmlEntity<
infer Schema,
any
>
? InferSchemaFieldsForModuleServices<Schema>
: never
/**
* The actions to cascade from a given entity to its
* relationship.

65
packages/core/utils/src/modules-sdk/__tests__/medusa-service-typings.spec.ts
View File

@@ -6,9 +6,28 @@ import { InferTypeOf } from "@medusajs/types"
const Blog = model.define("Blog", {
id: model.text(),
title: model.text(),
tags: model.manyToMany(() => Tag),
comments: model.hasMany(() => Comment),
description: model.text().nullable(),
})
const Tag = model.define("Tag", {
id: model.text(),
title: model.text(),
})
const Comment = model.define("Comment", {
id: model.text(),
post: model.belongsTo(() => Blog),
author: model.belongsTo(() => User),
description: model.text().nullable(),
})
const User = model.define("User", {
id: model.text(),
username: model.text(),
})
type BlogDTO = {
id: number
title: string
@@ -55,7 +74,7 @@ const containerMock = {
describe("Medusa Service typings", () => {
describe("create<Service>", () => {
test("type-hint model properties", () => {
class BlogService extends MedusaService({ Blog }) {}
class BlogService extends MedusaService({ Blog, Comment }) {}
const blogService = new BlogService(containerMock)
expectTypeOf(blogService.createBlogs).parameters.toEqualTypeOf<
@@ -63,6 +82,8 @@ describe("Medusa Service typings", () => {
Partial<{
id: string | undefined
title: string | undefined
comments: string[] | undefined
tags: string[] | undefined
description: string | null | undefined
}>,
...rest: any[]
@@ -71,6 +92,36 @@ describe("Medusa Service typings", () => {
Partial<{
id: string | undefined
title: string | undefined
comments: string[] | undefined
tags: string[] | undefined
description: string | null | undefined
}>[],
...rest: any[]
]
>()
expectTypeOf(blogService.createBlogs).returns.toEqualTypeOf<
Promise<InferTypeOf<typeof Blog>> | Promise<InferTypeOf<typeof Blog>[]>
>()
expectTypeOf(blogService.createComments).parameters.toEqualTypeOf<
| [
Partial<{
id: string | undefined
post: string | undefined
author: string | undefined
post_id: string | undefined
author_id: string | undefined
description: string | null | undefined
}>,
...rest: any[]
]
| [
Partial<{
id: string | undefined
post: string | undefined
author: string | undefined
post_id: string | undefined
author_id: string | undefined
description: string | null | undefined
}>[],
...rest: any[]
@@ -143,6 +194,8 @@ describe("Medusa Service typings", () => {
Partial<{
id: string | undefined
title: string | undefined
comments: string[] | undefined
tags: string[] | undefined
description: string | null | undefined
}>,
...rest: any[]
@@ -152,6 +205,8 @@ describe("Medusa Service typings", () => {
| Partial<{
id: string | undefined
title: string | undefined
comments: string[] | undefined
tags: string[] | undefined
description: string | null | undefined
}>[]
| {
@@ -160,11 +215,15 @@ describe("Medusa Service typings", () => {
| Partial<{
id: string | undefined
title: string | undefined
comments: string[] | undefined
tags: string[] | undefined
description: string | null | undefined
}>
| Partial<{
id: string | undefined
title: string | undefined
comments: string[] | undefined
tags: string[] | undefined
description: string | null | undefined
}>[]
}
@@ -174,11 +233,15 @@ describe("Medusa Service typings", () => {
| Partial<{
id: string | undefined
title: string | undefined
comments: string[] | undefined
tags: string[] | undefined
description: string | null | undefined
}>
| Partial<{
id: string | undefined
title: string | undefined
comments: string[] | undefined
tags: string[] | undefined
description: string | null | undefined
}>[]
}[]

5
packages/core/utils/src/modules-sdk/types/medusa-service.ts
View File

@@ -3,11 +3,12 @@ import {
Context,
FindConfig,
IDmlEntity,
InferEntityType,
Pluralize,
Prettify,
RestoreReturn,
SoftDeleteReturn,
InferEntityType,
InferEntityForModuleService,
} from "@medusajs/types"
import { DmlEntity } from "../../dml"
@@ -45,7 +46,7 @@ export type ModelConfigurationsToConfigTemplate<T extends ModelEntries> = {
? InstanceType<T[Key]>
: any
inputDto: T[Key] extends DmlEntity<any, any>
? Omit<InferEntityType<T[Key]>, DMLDTOExcludeProperties>
? Omit<InferEntityForModuleService<T[Key]>, DMLDTOExcludeProperties>
: T[Key] extends Constructor<any>
? InstanceType<T[Key]>
: any