chore: Internal medusa service proper typings with DML (#7792)

packages/core/types/src/bundles.ts

@@ -30,3 +30,4 @@ export * as TransactionBaseTypes from "./transaction-base"
 export * as UserTypes from "./user"
 export * as WorkflowTypes from "./workflow"
 export * as WorkflowsSdkTypes from "./workflows-sdk"
+export * as DmlTypes from "./dml"

packages/core/types/src/dml/index.ts

@@ -1,4 +1,11 @@
-import { DmlEntity } from "./entity"
+export const IsDmlEntity = Symbol.for("isDmlEntity")
+
+export interface IDmlEntity<
+  Schema extends Record<string, PropertyType<any> | RelationshipType<any>>
+> {
+  [IsDmlEntity]: true
+  schema: Schema
+}
 
 /**
  * The supported data types
@@ -92,7 +99,7 @@ export interface EntityConstructor<Props> extends Function {
 /**
  * Helper to infer the schema type of a DmlEntity
  */
-export type Infer<T> = T extends DmlEntity<infer Schema>
+export type Infer<T> = T extends IDmlEntity<infer Schema>
   ? EntityConstructor<{
       [K in keyof Schema]: Schema[K]["$dataType"] extends () => infer R
         ? Infer<R>
@@ -123,3 +130,15 @@ export type ExtractEntityRelations<
 export type EntityCascades<Relationships> = {
   delete?: Relationships
 }
+
+/**
+ * Helper to infer the instance type of a DmlEntity once converted as an Entity
+ */
+export type InferTypeOf<T extends IDmlEntity<any>> = InstanceType<Infer<T>>
+
+/**
+ * Used in the module sdk internal service to infer propert entity typings from DML
+ */
+export type ExtractEntityType<T extends any> = T extends IDmlEntity<any>
+  ? InferTypeOf<T>
+  : T

packages/core/types/src/index.ts

@@ -41,3 +41,4 @@ export * from "./user"
 export * from "./workflow"
 export * from "./workflows"
 export * from "./workflows-sdk"
+export * from "./dml"

packages/core/types/src/modules-sdk/medusa-internal-service.ts

@@ -7,6 +7,7 @@ import {
   PerformedActions,
   UpsertWithReplaceConfig,
 } from "../dal"
+import { ExtractEntityType } from "../dml"
 
 export interface IMedusaInternalService<
   TEntity extends {},
@@ -18,44 +19,56 @@ export interface IMedusaInternalService<
     idOrObject: string,
     config?: FindConfig<any>,
     sharedContext?: Context
-  ): Promise<TEntity>
+  ): Promise<ExtractEntityType<TEntity>>
   retrieve(
     idOrObject: object,
     config?: FindConfig<any>,
     sharedContext?: Context
-  ): Promise<TEntity>
+  ): Promise<ExtractEntityType<TEntity>>
 
   list(
     filters?: FilterQuery<any> | BaseFilterable<FilterQuery<any>>,
     config?: FindConfig<any>,
     sharedContext?: Context
-  ): Promise<TEntity[]>
+  ): Promise<ExtractEntityType<TEntity>[]>
 
   listAndCount(
     filters?: FilterQuery<any> | BaseFilterable<FilterQuery<any>>,
     config?: FindConfig<any>,
     sharedContext?: Context
-  ): Promise<[TEntity[], number]>
+  ): Promise<[ExtractEntityType<TEntity>[], number]>
 
-  create(data: any[], sharedContext?: Context): Promise<TEntity[]>
-  create(data: any, sharedContext?: Context): Promise<TEntity>
+  create(
+    data: any[],
+    sharedContext?: Context
+  ): Promise<ExtractEntityType<TEntity>[]>
+  create(
+    data: any,
+    sharedContext?: Context
+  ): Promise<ExtractEntityType<TEntity>>
 
-  update(data: any[], sharedContext?: Context): Promise<TEntity[]>
-  update(data: any, sharedContext?: Context): Promise<TEntity>
+  update(
+    data: any[],
+    sharedContext?: Context
+  ): Promise<ExtractEntityType<TEntity>[]>
+  update(
+    data: any,
+    sharedContext?: Context
+  ): Promise<ExtractEntityType<TEntity>>
   update(
     selectorAndData: {
       selector: FilterQuery<any> | BaseFilterable<FilterQuery<any>>
       data: any
     },
     sharedContext?: Context
-  ): Promise<TEntity[]>
+  ): Promise<ExtractEntityType<TEntity>[]>
   update(
     selectorAndData: {
       selector: FilterQuery<any> | BaseFilterable<FilterQuery<any>>
       data: any
     }[],
     sharedContext?: Context
-  ): Promise<TEntity[]>
+  ): Promise<ExtractEntityType<TEntity>[]>
 
   delete(idOrSelector: string, sharedContext?: Context): Promise<void>
   delete(idOrSelector: string[], sharedContext?: Context): Promise<void>
@@ -75,19 +88,28 @@ export interface IMedusaInternalService<
       | InternalFilterQuery
       | InternalFilterQuery[],
     sharedContext?: Context
-  ): Promise<[TEntity[], Record<string, unknown[]>]>
+  ): Promise<[ExtractEntityType<TEntity>[], Record<string, unknown[]>]>
 
   restore(
     idsOrFilter: string[] | InternalFilterQuery,
     sharedContext?: Context
-  ): Promise<[TEntity[], Record<string, unknown[]>]>
+  ): Promise<[ExtractEntityType<TEntity>[], Record<string, unknown[]>]>
 
-  upsert(data: any[], sharedContext?: Context): Promise<TEntity[]>
-  upsert(data: any, sharedContext?: Context): Promise<TEntity>
+  upsert(
+    data: any[],
+    sharedContext?: Context
+  ): Promise<ExtractEntityType<TEntity>[]>
+  upsert(
+    data: any,
+    sharedContext?: Context
+  ): Promise<ExtractEntityType<TEntity>>
 
   upsertWithReplace(
     data: any[],
-    config?: UpsertWithReplaceConfig<TEntity>,
+    config?: UpsertWithReplaceConfig<ExtractEntityType<TEntity>>,
     sharedContext?: Context
-  ): Promise<{ entities: TEntity[]; performedActions: PerformedActions }>
+  ): Promise<{
+    entities: ExtractEntityType<TEntity>[]
+    performedActions: PerformedActions
+  }>
 }

packages/core/utils/package.json

@@ -21,7 +21,6 @@
   "author": "Medusa",
   "license": "MIT",
   "devDependencies": {
-    "@medusajs/types": "^1.11.16",
     "@types/express": "^4.17.17",
     "cross-env": "^5.2.1",
     "expect-type": "^0.19.0",
@@ -32,6 +31,7 @@
     "typescript": "^5.1.6"
   },
   "dependencies": {
+    "@medusajs/types": "^1.11.16",
     "@mikro-orm/core": "5.9.7",
     "@mikro-orm/migrations": "5.9.7",
     "@mikro-orm/postgresql": "5.9.7",

packages/core/utils/src/dml/__tests__/base-property.spec.ts

@@ -1,6 +1,6 @@
 import { expectTypeOf } from "expect-type"
 import { BaseProperty } from "../properties/base"
-import { PropertyMetadata } from "../types"
+import { PropertyMetadata } from "@medusajs/types"
 
 describe("Base property", () => {
   test("create a property type from base property", () => {

packages/core/utils/src/dml/entity-builder.ts

@@ -13,7 +13,7 @@ import type {
   PropertyType,
   RelationshipOptions,
   RelationshipType,
-} from "./types"
+} from "@medusajs/types"
 import { NullableModifier } from "./properties/nullable"
 import { IdProperty } from "./properties/id"
 

packages/core/utils/src/dml/entity.ts

@@ -2,11 +2,11 @@ import { BelongsTo } from "./relations/belongs-to"
 import {
   EntityCascades,
   ExtractEntityRelations,
+  IDmlEntity,
+  IsDmlEntity,
   PropertyType,
   RelationshipType,
-} from "./types"
-
-const IsDmlEntity = Symbol("isDmlEntity")
+} from "@medusajs/types"
 
 /**
  * Dml entity is a representation of a DML model with a unique
@@ -14,8 +14,9 @@ const IsDmlEntity = Symbol("isDmlEntity")
  */
 export class DmlEntity<
   Schema extends Record<string, PropertyType<any> | RelationshipType<any>>
-> {
-  [IsDmlEntity] = true
+> implements IDmlEntity<Schema>
+{
+  [IsDmlEntity]: true = true
 
   #cascades: EntityCascades<string[]> = {}
   constructor(public name: string, public schema: Schema) {}

packages/core/utils/src/dml/helpers/create-mikro-orm-entity.ts

@@ -34,7 +34,7 @@ import type {
   PropertyType,
   RelationshipMetadata,
   RelationshipType,
-} from "../types"
+} from "@medusajs/types"
 
 /**
  * DML entity data types to PostgreSQL data types via

packages/core/utils/src/dml/properties/base.ts

@@ -1,4 +1,4 @@
-import { PropertyMetadata, PropertyType } from "../types"
+import { PropertyMetadata, PropertyType } from "@medusajs/types"
 import { NullableModifier } from "./nullable"
 
 /**

packages/core/utils/src/dml/properties/nullable.ts

@@ -1,4 +1,4 @@
-import { PropertyType } from "../types"
+import { PropertyType } from "@medusajs/types"
 
 /**
  * Nullable modifier marks a schema node as nullable

packages/core/utils/src/dml/relations/base.ts

@@ -3,7 +3,7 @@ import {
   RelationshipOptions,
   RelationshipType,
   RelationshipTypes,
-} from "../types"
+} from "@medusajs/types"
 
 /**
  * The BaseRelationship encapsulates the repetitive parts of defining

packages/core/utils/src/dml/relations/belongs-to.ts

@@ -1,5 +1,4 @@
 import { BaseRelationship } from "./base"
-import { RelationshipTypes } from "../types"
 import { NullableModifier } from "./nullable"
 
 export class BelongsTo<T> extends BaseRelationship<T> {

packages/core/utils/src/dml/relations/has-many.ts

@@ -1,5 +1,4 @@
 import { BaseRelationship } from "./base"
-import { RelationshipTypes } from "../types"
 
 /**
  * HasMany relationship defines a relationship between two entities

packages/core/utils/src/dml/relations/has-one.ts

@@ -1,6 +1,5 @@
 import { BaseRelationship } from "./base"
 import { NullableModifier } from "./nullable"
-import { RelationshipTypes } from "../types"
 
 /**
  * HasOne relationship defines a relationship between two entities

packages/core/utils/src/dml/relations/many-to-many.ts

@@ -1,5 +1,4 @@
 import { BaseRelationship } from "./base"
-import { RelationshipTypes } from "../types"
 
 /**
  * ManyToMany relationship defines a relationship between two entities

packages/core/utils/src/dml/relations/nullable.ts

@@ -1,4 +1,4 @@
-import { RelationshipType, PropertyType } from "../types"
+import { RelationshipType } from "@medusajs/types"
 
 /**
  * Nullable modifier marks a schema node as nullable

packages/core/utils/src/modules-sdk/medusa-internal-service.ts

@@ -1,6 +1,7 @@
 import {
   BaseFilterable,
   Context,
+  ExtractEntityType,
   FilterQuery,
   FilterQuery as InternalFilterQuery,
   FindConfig,
@@ -100,9 +101,9 @@ export function MedusaInternalService<TContainer extends object = object>(
     @InjectManager(propertyRepositoryName)
     async retrieve(
       idOrObject: string | object,
-      config: FindConfig<TEntity> = {},
+      config: FindConfig<ExtractEntityType<TEntity>> = {},
       @MedusaContext() sharedContext: Context = {}
-    ): Promise<TEntity> {
+    ): Promise<ExtractEntityType<TEntity>> {
       const primaryKeys = AbstractService_.retrievePrimaryKeys(model)
 
       if (
@@ -162,7 +163,7 @@ export function MedusaInternalService<TContainer extends object = object>(
       filters: FilterQuery<any> | BaseFilterable<FilterQuery<any>> = {},
       config: FindConfig<any> = {},
       @MedusaContext() sharedContext: Context = {}
-    ): Promise<TEntity[]> {
+    ): Promise<ExtractEntityType<TEntity>[]> {
       AbstractService_.applyDefaultOrdering(config)
       AbstractService_.applyFreeTextSearchFilter(filters, config)
 
@@ -179,7 +180,7 @@ export function MedusaInternalService<TContainer extends object = object>(
       filters: FilterQuery<any> | BaseFilterable<FilterQuery<any>> = {},
       config: FindConfig<any> = {},
       @MedusaContext() sharedContext: Context = {}
-    ): Promise<[TEntity[], number]> {
+    ): Promise<[ExtractEntityType<TEntity>[], number]> {
       AbstractService_.applyDefaultOrdering(config)
       AbstractService_.applyFreeTextSearchFilter(filters, config)
 
@@ -191,16 +192,24 @@ export function MedusaInternalService<TContainer extends object = object>(
       )
     }
 
-    create(data: any, sharedContext?: Context): Promise<TEntity>
-    create(data: any[], sharedContext?: Context): Promise<TEntity[]>
+    create(
+      data: any,
+      sharedContext?: Context
+    ): Promise<ExtractEntityType<TEntity>>
+    create(
+      data: any[],
+      sharedContext?: Context
+    ): Promise<ExtractEntityType<TEntity>[]>
 
     @InjectTransactionManager(shouldForceTransaction, propertyRepositoryName)
     async create(
       data: any | any[],
       @MedusaContext() sharedContext: Context = {}
-    ): Promise<TEntity | TEntity[]> {
+    ): Promise<ExtractEntityType<TEntity> | ExtractEntityType<TEntity>[]> {
       if (!isDefined(data) || (Array.isArray(data) && data.length === 0)) {
-        return (Array.isArray(data) ? [] : void 0) as TEntity | TEntity[]
+        return (Array.isArray(data) ? [] : void 0) as
+          | ExtractEntityType<TEntity>
+          | ExtractEntityType<TEntity>[]
       }
 
       const data_ = Array.isArray(data) ? data : [data]
@@ -212,24 +221,32 @@ export function MedusaInternalService<TContainer extends object = object>(
       return Array.isArray(data) ? entities : entities[0]
     }
 
-    update(data: any[], sharedContext?: Context): Promise<TEntity[]>
-    update(data: any, sharedContext?: Context): Promise<TEntity>
+    update(
+      data: any[],
+      sharedContext?: Context
+    ): Promise<ExtractEntityType<TEntity>[]>
+    update(
+      data: any,
+      sharedContext?: Context
+    ): Promise<ExtractEntityType<TEntity>>
     update(
       selectorAndData: SelectorAndData,
       sharedContext?: Context
-    ): Promise<TEntity[]>
+    ): Promise<ExtractEntityType<TEntity>[]>
     update(
       selectorAndData: SelectorAndData[],
       sharedContext?: Context
-    ): Promise<TEntity[]>
+    ): Promise<ExtractEntityType<TEntity>[]>
 
     @InjectTransactionManager(shouldForceTransaction, propertyRepositoryName)
     async update(
       input: any | any[] | SelectorAndData | SelectorAndData[],
       @MedusaContext() sharedContext: Context = {}
-    ): Promise<TEntity | TEntity[]> {
+    ): Promise<ExtractEntityType<TEntity> | ExtractEntityType<TEntity>[]> {
       if (!isDefined(input) || (Array.isArray(input) && input.length === 0)) {
-        return (Array.isArray(input) ? [] : void 0) as TEntity | TEntity[]
+        return (Array.isArray(input) ? [] : void 0) as
+          | ExtractEntityType<TEntity>
+          | ExtractEntityType<TEntity>[]
       }
 
       const primaryKeys = AbstractService_.retrievePrimaryKeys(model)
@@ -294,7 +311,8 @@ export function MedusaInternalService<TContainer extends object = object>(
 
         // Only throw for missing entities when we dont have selectors involved as selector by design can return 0 entities
         if (entitiesToUpdate.length !== keySelectorDataMap.size) {
-          const entityName = (model as EntityClass<TEntity>).name ?? model
+          const entityName =
+            (model as EntityClass<ExtractEntityType<TEntity>>).name ?? model
 
           const compositeKeysValuesForFoundEntities = new Set(
             entitiesToUpdate.map((entity) => {
@@ -447,7 +465,7 @@ export function MedusaInternalService<TContainer extends object = object>(
         | InternalFilterQuery
         | InternalFilterQuery[],
       @MedusaContext() sharedContext: Context = {}
-    ): Promise<[TEntity[], Record<string, unknown[]>]> {
+    ): Promise<[ExtractEntityType<TEntity>[], Record<string, unknown[]>]> {
       if (
         (Array.isArray(idsOrFilter) && !idsOrFilter.length) ||
         (!Array.isArray(idsOrFilter) && !idsOrFilter)
@@ -465,21 +483,27 @@ export function MedusaInternalService<TContainer extends object = object>(
     async restore(
       idsOrFilter: string[] | InternalFilterQuery,
       @MedusaContext() sharedContext: Context = {}
-    ): Promise<[TEntity[], Record<string, unknown[]>]> {
+    ): Promise<[ExtractEntityType<TEntity>[], Record<string, unknown[]>]> {
       return await this[propertyRepositoryName].restore(
         idsOrFilter,
         sharedContext
       )
     }
 
-    upsert(data: any[], sharedContext?: Context): Promise<TEntity[]>
-    upsert(data: any, sharedContext?: Context): Promise<TEntity>
+    upsert(
+      data: any[],
+      sharedContext?: Context
+    ): Promise<ExtractEntityType<TEntity>[]>
+    upsert(
+      data: any,
+      sharedContext?: Context
+    ): Promise<ExtractEntityType<TEntity>>
 
     @InjectTransactionManager(propertyRepositoryName)
     async upsert(
       data: any | any[],
       @MedusaContext() sharedContext: Context = {}
-    ): Promise<TEntity | TEntity[]> {
+    ): Promise<ExtractEntityType<TEntity> | ExtractEntityType<TEntity>[]> {
       const data_ = Array.isArray(data) ? data : [data]
       const entities = await this[propertyRepositoryName].upsert(
         data_,
@@ -490,24 +514,30 @@ export function MedusaInternalService<TContainer extends object = object>(
 
     upsertWithReplace(
       data: any[],
-      config?: UpsertWithReplaceConfig<TEntity>,
+      config?: UpsertWithReplaceConfig<ExtractEntityType<TEntity>>,
       sharedContext?: Context
-    ): Promise<{ entities: TEntity[]; performedActions: PerformedActions }>
+    ): Promise<{
+      entities: ExtractEntityType<TEntity>[]
+      performedActions: PerformedActions
+    }>
     upsertWithReplace(
       data: any,
-      config?: UpsertWithReplaceConfig<TEntity>,
+      config?: UpsertWithReplaceConfig<ExtractEntityType<TEntity>>,
       sharedContext?: Context
-    ): Promise<{ entities: TEntity; performedActions: PerformedActions }>
+    ): Promise<{
+      entities: ExtractEntityType<TEntity>
+      performedActions: PerformedActions
+    }>
 
     @InjectTransactionManager(propertyRepositoryName)
     async upsertWithReplace(
       data: any | any[],
-      config: UpsertWithReplaceConfig<TEntity> = {
+      config: UpsertWithReplaceConfig<ExtractEntityType<TEntity>> = {
         relations: [],
       },
       @MedusaContext() sharedContext: Context = {}
     ): Promise<{
-      entities: TEntity | TEntity[]
+      entities: ExtractEntityType<TEntity> | TEntity[]
       performedActions: PerformedActions
     }> {
       const data_ = Array.isArray(data) ? data : [data]