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

chore: Rename entity to model (#7977)

Browse Source 
**What**
Start renaming `entity` to `model`
This commit is contained in:
Adrien de Peretti
2024-07-08 07:43:49 +00:00
committed by GitHub
parent e11716fa1e
commit 9750047af1
60 changed files with 171 additions and 171 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/core/utils/src/modules-sdk/joiner-config-builder.ts
+1 -1
View File
@@ -410,7 +410,7 @@ export function buildLinkConfigFromLinkableKeys<
* Reversed map from linkableKeys to entity name to linkable keys
* @param linkableKeys
*/
export function buildEntitiesNameToLinkableKeysMap(
export function buildModelsNameToLinkableKeysMap(
linkableKeys: Record<string, string>
): MapToConfig {
const entityLinkableKeysMap: MapToConfig = {}
packages/core/utils/src/modules-sdk/medusa-service.ts
+56 -56
View File
@@ -23,13 +23,13 @@ import { InjectManager, MedusaContext } from "./decorators"
import { ModuleRegistrationName } from "./definition"
import {
BaseMethods,
EntitiesConfigTemplate,
ExtractKeysFromConfig,
MedusaServiceReturnType,
ModelConfigurationsToConfigTemplate,
TEntityEntries,
ModelEntries,
ModelsConfigTemplate,
} from "./types/medusa-service"
import { buildEntitiesNameToLinkableKeysMap } from "./joiner-config-builder"
import { buildModelsNameToLinkableKeysMap } from "./joiner-config-builder"
const readMethods = ["retrieve", "list", "listAndCount"] as BaseMethods[]
const writeMethods = [
@@ -47,7 +47,7 @@ const methods: BaseMethods[] = [...readMethods, ...writeMethods]
*/
function buildMethodNamesFromModel(
modelName: string,
model: TEntityEntries[keyof TEntityEntries]
model: ModelEntries[keyof ModelEntries]
): Record<string, string> {
return methods.reduce((acc, method) => {
let normalizedModelName: string = ""
@@ -79,11 +79,11 @@ export const MedusaServiceModelObjectsSymbol = Symbol.for(
export const MedusaServiceSymbol = Symbol.for("MedusaServiceSymbol")
/**
* Accessible from the MedusaService, holds the entity name to linkable keys map
* Accessible from the MedusaService, holds the model name to linkable keys map
* to be used for softDelete and restore methods
*/
export const MedusaServiceEntityNameToLinkableKeysMapSymbol = Symbol.for(
"MedusaServiceEntityNameToLinkableKeysMapSymbol"
export const MedusaServiceModelNameToLinkableKeysMapSymbol = Symbol.for(
"MedusaServiceModelNameToLinkableKeysMapSymbol"
)
/**
@@ -103,7 +103,7 @@ export function isMedusaService(
*
* // Here the DTO's and names will be inferred from the arguments
*
* const entities = {
* const models = {
* Currency,
* Price,
* PriceList,
@@ -114,21 +114,21 @@ export function isMedusaService(
* RuleType,
* }
*
* class MyService extends ModulesSdkUtils.MedusaService(entities) {}
* class MyService extends ModulesSdkUtils.MedusaService(models) {}
*
* @param entities
* @param models
*/
export function MedusaService<
const EntitiesConfig extends EntitiesConfigTemplate = { __empty: any },
const TEntities extends TEntityEntries<
ExtractKeysFromConfig<EntitiesConfig>
> = TEntityEntries<ExtractKeysFromConfig<EntitiesConfig>>
const ModelsConfig extends ModelsConfigTemplate = { __empty: any },
const TModels extends ModelEntries<
ExtractKeysFromConfig<ModelsConfig>
> = ModelEntries<ExtractKeysFromConfig<ModelsConfig>>
>(
entities: TEntities
models: TModels
): MedusaServiceReturnType<
EntitiesConfig extends { __empty: any }
? ModelConfigurationsToConfigTemplate<TEntities>
: EntitiesConfig
ModelsConfig extends { __empty: any }
? ModelConfigurationsToConfigTemplate<TModels>
: ModelsConfig
> {
const buildAndAssignMethodImpl = function (
klassPrototype: any,
@@ -168,11 +168,11 @@ export function MedusaService<
config?: FindConfig<any>,
sharedContext: Context = {}
): Promise<T> {
const entities = await this.__container__[
const models = await this.__container__[
serviceRegistrationName
].retrieve(id, config, sharedContext)
return await this.baseRepository_.serialize<T>(entities)
return await this.baseRepository_.serialize<T>(models)
}
applyMethod(methodImplementation, 2)
@@ -186,8 +186,8 @@ export function MedusaService<
): Promise<T | T[]> {
const serviceData = Array.isArray(data) ? data : [data]
const service = this.__container__[serviceRegistrationName]
const entities = await service.create(serviceData, sharedContext)
const response = Array.isArray(data) ? entities : entities[0]
const models = await service.create(serviceData, sharedContext)
const response = Array.isArray(data) ? models : models[0]
return await this.baseRepository_.serialize<T | T[]>(response)
}
@@ -203,8 +203,8 @@ export function MedusaService<
): Promise<T | T[]> {
const serviceData = Array.isArray(data) ? data : [data]
const service = this.__container__[serviceRegistrationName]
const entities = await service.update(serviceData, sharedContext)
const response = Array.isArray(data) ? entities : entities[0]
const models = await service.update(serviceData, sharedContext)
const response = Array.isArray(data) ? models : models[0]
return await this.baseRepository_.serialize<T | T[]>(response)
}
@@ -220,9 +220,9 @@ export function MedusaService<
sharedContext: Context = {}
): Promise<T[]> {
const service = this.__container__[serviceRegistrationName]
const entities = await service.list(filters, config, sharedContext)
const models = await service.list(filters, config, sharedContext)
return await this.baseRepository_.serialize<T[]>(entities)
return await this.baseRepository_.serialize<T[]>(models)
}
applyMethod(methodImplementation, 2)
@@ -235,11 +235,11 @@ export function MedusaService<
config: FindConfig<any> = {},
sharedContext: Context = {}
): Promise<T[]> {
const [entities, count] = await this.__container__[
const [models, count] = await this.__container__[
serviceRegistrationName
].listAndCount(filters, config, sharedContext)
return [await this.baseRepository_.serialize<T[]>(entities), count]
return [await this.baseRepository_.serialize<T[]>(models), count]
}
applyMethod(methodImplementation, 2)
@@ -283,16 +283,16 @@ export function MedusaService<
? primaryKeyValues
: [primaryKeyValues]
const [entities, cascadedEntitiesMap] = await this.__container__[
const [models, cascadedModelsMap] = await this.__container__[
serviceRegistrationName
].softDelete(primaryKeyValues_, sharedContext)
const softDeletedEntities = await this.baseRepository_.serialize<T[]>(
entities
const softDeletedModels = await this.baseRepository_.serialize<T[]>(
models
)
await this.eventBusModuleService_?.emit(
softDeletedEntities.map(({ id }) => ({
softDeletedModels.map(({ id }) => ({
eventName: `${kebabCase(modelName)}.deleted`,
metadata: { source: "", action: "", object: "" },
data: { id },
@@ -301,15 +301,15 @@ export function MedusaService<
// Map internal table/column names to their respective external linkable keys
// eg: product.id = product_id, variant.id = variant_id
const mappedCascadedEntitiesMap = mapObjectTo(
cascadedEntitiesMap,
this[MedusaServiceEntityNameToLinkableKeysMapSymbol],
const mappedCascadedModelsMap = mapObjectTo(
cascadedModelsMap,
this[MedusaServiceModelNameToLinkableKeysMapSymbol],
{
pick: config.returnLinkableKeys,
}
)
return mappedCascadedEntitiesMap ? mappedCascadedEntitiesMap : void 0
return mappedCascadedModelsMap ? mappedCascadedModelsMap : void 0
}
applyMethod(methodImplementation, 2)
@@ -326,22 +326,22 @@ export function MedusaService<
? primaryKeyValues
: [primaryKeyValues]
const [_, cascadedEntitiesMap] = await this.__container__[
const [_, cascadedModelsMap] = await this.__container__[
serviceRegistrationName
].restore(primaryKeyValues_, sharedContext)
let mappedCascadedEntitiesMap
let mappedCascadedModelsMap
// Map internal table/column names to their respective external linkable keys
// eg: product.id = product_id, variant.id = variant_id
mappedCascadedEntitiesMap = mapObjectTo(
cascadedEntitiesMap,
this[MedusaServiceEntityNameToLinkableKeysMapSymbol],
mappedCascadedModelsMap = mapObjectTo(
cascadedModelsMap,
this[MedusaServiceModelNameToLinkableKeysMapSymbol],
{
pick: config.returnLinkableKeys,
}
)
return mappedCascadedEntitiesMap ? mappedCascadedEntitiesMap : void 0
return mappedCascadedModelsMap ? mappedCascadedModelsMap : void 0
}
applyMethod(methodImplementation, 2)
@@ -354,13 +354,13 @@ export function MedusaService<
[MedusaServiceSymbol] = true
static [MedusaServiceModelObjectsSymbol] =
entities as unknown as MedusaServiceReturnType<
EntitiesConfig extends { __empty: any }
? ModelConfigurationsToConfigTemplate<TEntities>
: EntitiesConfig
models as unknown as MedusaServiceReturnType<
ModelsConfig extends { __empty: any }
? ModelConfigurationsToConfigTemplate<TModels>
: ModelsConfig
>["$modelObjects"];
[MedusaServiceEntityNameToLinkableKeysMapSymbol]: MapToConfig
[MedusaServiceModelNameToLinkableKeysMapSymbol]: MapToConfig
readonly __container__: Record<any, any>
readonly baseRepository_: RepositoryService
@@ -380,8 +380,8 @@ export function MedusaService<
? this.__container__.eventBusModuleService
: undefined
this[MedusaServiceEntityNameToLinkableKeysMapSymbol] =
buildEntitiesNameToLinkableKeysMap(
this[MedusaServiceModelNameToLinkableKeysMapSymbol] =
buildModelsNameToLinkableKeysMap(
this.__joinerConfig?.()?.linkableKeys ?? {}
)
}
@@ -404,18 +404,18 @@ export function MedusaService<
* Build the retrieve/list/listAndCount/delete/softDelete/restore methods for all the other models
*/
const entitiesMethods: [
const modelsMethods: [
string,
TEntities[keyof TEntities],
TModels[keyof TModels],
Record<string, string>
][] = Object.entries(entities as {}).map(([name, config]) => [
][] = Object.entries(models as {}).map(([name, config]) => [
name,
config as TEntities[keyof TEntities],
buildMethodNamesFromModel(name, config as TEntities[keyof TEntities]),
config as TModels[keyof TModels],
buildMethodNamesFromModel(name, config as TModels[keyof TModels]),
])
for (let [modelName, model, modelsMethods] of entitiesMethods) {
Object.entries(modelsMethods).forEach(([method, methodName]) => {
for (let [modelName, model, modelMethods] of modelsMethods) {
Object.entries(modelMethods).forEach(([method, methodName]) => {
buildAndAssignMethodImpl(
AbstractModuleService_.prototype,
method,
packages/core/utils/src/modules-sdk/types/medusa-service.ts
+56 -56
View File
@@ -36,9 +36,9 @@ export type ModelDTOConfig = {
plural?: string
}
export type EntitiesConfigTemplate = { [key: string]: ModelDTOConfig }
export type ModelsConfigTemplate = { [key: string]: ModelDTOConfig }
export type ModelConfigurationsToConfigTemplate<T extends TEntityEntries> = {
export type ModelConfigurationsToConfigTemplate<T extends ModelEntries> = {
[Key in keyof T]: {
dto: T[Key] extends Constructor<any> ? InstanceType<T[Key]> : any
model: T[Key] extends { model: infer MODEL }
@@ -90,7 +90,7 @@ export type ExtractPluralName<
>
// TODO: The future expected entry will be a MODEL object but in the meantime we have to maintain backward compatibility for ouw own modules and therefore we need to support Constructor<any> as well as this temporary object
export type TEntityEntries<Keys = string> = Record<
export type ModelEntries<Keys = string> = Record<
Keys & string,
| DmlEntity<any, any>
/**
@@ -103,45 +103,45 @@ export type TEntityEntries<Keys = string> = Record<
| { name?: string; singular?: string; plural?: string }
>
export type ExtractKeysFromConfig<EntitiesConfig> = EntitiesConfig extends {
export type ExtractKeysFromConfig<ModelsConfig> = ModelsConfig extends {
__empty: any
}
? string
: keyof EntitiesConfig
: keyof ModelsConfig
export type AbstractModuleService<
TEntitiesDtoConfig extends Record<string, any>
TModelsDtoConfig extends Record<string, any>
> = {
[TEntityName in keyof TEntitiesDtoConfig as `retrieve${ExtractSingularName<
TEntitiesDtoConfig,
TEntityName
[TModelName in keyof TModelsDtoConfig as `retrieve${ExtractSingularName<
TModelsDtoConfig,
TModelName
>}`]: (
id: string,
config?: FindConfig<any>,
sharedContext?: Context
) => Promise<TEntitiesDtoConfig[TEntityName]["dto"]>
) => Promise<TModelsDtoConfig[TModelName]["dto"]>
} & {
[TEntityName in keyof TEntitiesDtoConfig as `list${ExtractPluralName<
TEntitiesDtoConfig,
TEntityName
[TModelName in keyof TModelsDtoConfig as `list${ExtractPluralName<
TModelsDtoConfig,
TModelName
>}`]: (
filters?: any,
config?: FindConfig<any>,
sharedContext?: Context
) => Promise<TEntitiesDtoConfig[TEntityName]["dto"][]>
) => Promise<TModelsDtoConfig[TModelName]["dto"][]>
} & {
[TEntityName in keyof TEntitiesDtoConfig as `listAndCount${ExtractPluralName<
TEntitiesDtoConfig,
TEntityName
[TModelName in keyof TModelsDtoConfig as `listAndCount${ExtractPluralName<
TModelsDtoConfig,
TModelName
>}`]: {
(filters?: any, config?: FindConfig<any>, sharedContext?: Context): Promise<
[TEntitiesDtoConfig[TEntityName]["dto"][], number]
[TModelsDtoConfig[TModelName]["dto"][], number]
>
}
} & {
[TEntityName in keyof TEntitiesDtoConfig as `delete${ExtractPluralName<
TEntitiesDtoConfig,
TEntityName
[TModelName in keyof TModelsDtoConfig as `delete${ExtractPluralName<
TModelsDtoConfig,
TModelName
>}`]: {
(
primaryKeyValues: string | object | string[] | object[],
@@ -149,9 +149,9 @@ export type AbstractModuleService<
): Promise<void>
}
} & {
[TEntityName in keyof TEntitiesDtoConfig as `softDelete${ExtractPluralName<
TEntitiesDtoConfig,
TEntityName
[TModelName in keyof TModelsDtoConfig as `softDelete${ExtractPluralName<
TModelsDtoConfig,
TModelName
>}`]: {
<TReturnableLinkableKeys extends string>(
primaryKeyValues: string | object | string[] | object[],
@@ -160,9 +160,9 @@ export type AbstractModuleService<
): Promise<Record<string, string[]> | void>
}
} & {
[TEntityName in keyof TEntitiesDtoConfig as `restore${ExtractPluralName<
TEntitiesDtoConfig,
TEntityName
[TModelName in keyof TModelsDtoConfig as `restore${ExtractPluralName<
TModelsDtoConfig,
TModelName
>}`]: {
<TReturnableLinkableKeys extends string>(
primaryKeyValues: string | object | string[] | object[],
@@ -171,16 +171,16 @@ export type AbstractModuleService<
): Promise<Record<string, string[]> | void>
}
} & {
[TEntityName in keyof TEntitiesDtoConfig as `create${ExtractPluralName<
TEntitiesDtoConfig,
TEntityName
[TModelName in keyof TModelsDtoConfig as `create${ExtractPluralName<
TModelsDtoConfig,
TModelName
>}`]: {
(...args: any[]): Promise<any>
}
} & {
[TEntityName in keyof TEntitiesDtoConfig as `update${ExtractPluralName<
TEntitiesDtoConfig,
TEntityName
[TModelName in keyof TModelsDtoConfig as `update${ExtractPluralName<
TModelsDtoConfig,
TModelName
>}`]: {
(...args: any[]): Promise<any>
}
@@ -190,53 +190,53 @@ export type AbstractModuleService<
// are not consistent accross modules
/* & {
[TEntityName in keyof TEntitiesDtoConfig as `create${ExtractPluralName<
TEntitiesDtoConfig,
TEntityName
[TModelName in keyof TModelsDtoConfig as `create${ExtractPluralName<
TModelsDtoConfig,
TModelName
>}`]: {
(data: any[], sharedContext?: Context): Promise<
TEntitiesDtoConfig[TEntityName]["dto"][]
TModelsDtoConfig[TModelName]["dto"][]
>
}
} & {
[TEntityName in keyof TEntitiesDtoConfig as `create${ExtractPluralName<
TEntitiesDtoConfig,
TEntityName
[TModelName in keyof TModelsDtoConfig as `create${ExtractPluralName<
TModelsDtoConfig,
TModelName
>}`]: {
(data: any, sharedContext?: Context): Promise<
TEntitiesDtoConfig[TEntityName]["dto"][]
TModelsDtoConfig[TModelName]["dto"][]
>
}
} & {
[TEntityName in keyof TEntitiesDtoConfig as `update${ExtractPluralName<
TEntitiesDtoConfig,
TEntityName
[TModelName in keyof TModelsDtoConfig as `update${ExtractPluralName<
TModelsDtoConfig,
TModelName
>}`]: {
(
data: TEntitiesDtoConfig[TEntityName]["update"][],
data: TModelsDtoConfig[TModelName]["update"][],
sharedContext?: Context
): Promise<TEntitiesDtoConfig[TEntityName]["dto"][]>
): Promise<TModelsDtoConfig[TModelName]["dto"][]>
}
} & {
[TEntityName in keyof TEntitiesDtoConfig as `update${ExtractPluralName<
TEntitiesDtoConfig,
TEntityName
[TModelName in keyof TModelsDtoConfig as `update${ExtractPluralName<
TModelsDtoConfig,
TModelName
>}`]: {
(
data: TEntitiesDtoConfig[TEntityName]["update"],
data: TModelsDtoConfig[TModelName]["update"],
sharedContext?: Context
): Promise<TEntitiesDtoConfig[TEntityName]["dto"]>
): Promise<TModelsDtoConfig[TModelName]["dto"]>
}
} & {
[TEntityName in keyof TEntitiesDtoConfig as `update${ExtractPluralName<
TEntitiesDtoConfig,
TEntityName
[TModelName in keyof TModelsDtoConfig as `update${ExtractPluralName<
TModelsDtoConfig,
TModelName
>}`]: {
(
idOrdSelector: any,
data: TEntitiesDtoConfig[TEntityName]["update"],
data: TModelsDtoConfig[TModelName]["update"],
sharedContext?: Context
): Promise<TEntitiesDtoConfig[TEntityName]["dto"][]>
): Promise<TModelsDtoConfig[TModelName]["dto"][]>
}
}*/