docs: updates to use DML and other changes (#7834)

- Change existing data model guides and add new ones for DML
- Change module's docs around service factory + remove guides that are now necessary
- Hide/remove all mentions of module relationships, or label them as coming soon.
- Change all data model creation snippets to use DML
- use `property` instead of `field` when referring to a data model's properties.
- Fix all snippets in commerce module guides to use new method suffix (no more main model methods)
- Rework recipes, removing/hiding a lot of sections as a lot of recipes are incomplete with the current state of DML.


### Other changes

- Highlight fixes in some guides
- Remove feature flags guide
- Fix code block styles when there are no line numbers.

### Upcoming changes in other PRs

- Re-generate commerce module references (for the updates in the method names)
- Ensure that the data model references are generated correctly for models using DML.
- (probably at a very later point) revisit recipes
This commit is contained in:
Shahed Nasser
2024-06-26 07:55:59 +00:00
committed by GitHub
parent 62dacdda75
commit 0462cc5acf
126 changed files with 1808 additions and 14242 deletions
@@ -15,7 +15,7 @@ The Order Module is the `@medusajs/order` NPM package that provides order-relate
Store and manage your orders to retriev, create, cancel, and perform other operations.
```ts
const order = await orderModuleService.create({
const order = await orderModuleService.createOrders({
currency_code: "usd",
items: [
{
@@ -38,7 +38,7 @@ const order = await orderModuleService.create({
Allow merchants to create orders on behalf of their customers as draft orders that later are transformed to regular orders.
```ts
const draftOrder = await orderModuleService.create({
const draftOrder = await orderModuleService.createOrders({
currency_code: "usd",
// other details...
status: "draft",
@@ -122,7 +122,7 @@ For example:
req.scope.resolve(ModuleRegistrationName.ORDER)
res.json({
orders: await orderModuleService.list(),
orders: await orderModuleService.listOrders(),
})
}
```
@@ -141,7 +141,7 @@ For example:
const orderModuleService: IOrderModuleService =
container.resolve(ModuleRegistrationName.ORDER)
const orders = await orderModuleService.list()
const orders = await orderModuleService.listOrders()
}
```
@@ -160,7 +160,7 @@ For example:
container.resolve(
ModuleRegistrationName.ORDER
)
const orders = await orderModuleService.list()
const orders = await orderModuleService.listOrders()
})
```