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

docs: updated extend entity documentation (#4498)

Browse Source
This commit is contained in:
Shahed Nasser
2023-07-11 21:48:36 +03:00
committed by GitHub
parent 9fe430ba7e
commit 703fdf8f5f
1 changed files with 3 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
docs/content/development/entities/extend-entity.md
View File

@@ -67,48 +67,7 @@ Notice that you must pass the attributes you added to the entity into the `inter
---
## Step 4: Extend Repository
As the entity is used throughout the commerce application through its repository, the core package will not actually be aware that the entity was extended unless you also extend the repository.
The steps here are similar to those described in the [How to Extend a Repository documentation](./extend-repository.md), however, the implementation is a little different.
Start by creating the repository file `src/repositories/product.ts`. As mentioned in the repository documentation, the name of the file should be the same as the name in the core. So, if you’re extending another repository, use the file name of that repository instead.
Then, in the file, add the following content:
```ts title=src/repositories/product.ts
import { Product } from "../models/product"
import {
dataSource,
} from "@medusajs/medusa/dist/loaders/database"
import {
// alias the core repository to not cause a naming conflict
ProductRepository as MedusaProductRepository,
} from "@medusajs/medusa/dist/repositories/product"
export const ProductRepository = dataSource
.getRepository(Product)
.extend({
// it is important to spread the existing repository here.
// Otherwise you will end up losing core properties.
// you also update the target to the extended entity
...Object.assign(
MedusaProductRepository,
{ target: Product }
),
// you can add other customizations as well...
})
export default ProductRepository
```
Instead of just spreading the properties of the `MedusaProductRepository` as you did when extending a repository, you have to change the value of the `target` property to be the entity you created.
---
## Step 5: Create Migration
## Step 4: Create Migration
To reflect your entity changes on the database schema, you must create a migration with those changes.
@@ -139,7 +98,7 @@ export default changeProduct1680013376180
---
## Step 6: Use Custom Entity
## Step 5: Use Custom Entity
For changes to take effect, you must transpile your code by running the `build` command in the root of the Medusa backend:
@@ -155,7 +114,7 @@ medusa migrations run
You should see that your migration was executed, which means your changes were reflected in the database schema.
You can now use your extended entity and its repository throughout your commerce application.
You can now use your extended entity throughout your commerce application.
---