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
@@ -26,7 +26,7 @@ In this guide, youll find common examples of how you can use the Currency Mod
req.scope.resolve(ModuleRegistrationName.CURRENCY)
res.json({
currencies: await currencyModuleService.list(),
currencies: await currencyModuleService.listCurrencies(),
})
}
```
@@ -42,10 +42,11 @@ In this guide, youll find common examples of how you can use the Currency Mod
} from "@medusajs/currency"
export async function GET(request: Request) {
const currencyModuleService = await initializeCurrencyModule()
const currencyModuleService =
await initializeCurrencyModule()
return NextResponse.json({
currencies: await currencyModuleService.list(),
currencies: await currencyModuleService.listCurrencies(),
})
}
```
@@ -72,7 +73,8 @@ In this guide, youll find common examples of how you can use the Currency Mod
const currencyModuleService: ICurrencyModuleService =
req.scope.resolve(ModuleRegistrationName.CURRENCY)
const currency = await currencyModuleService.retrieve("usd")
const currency = await currencyModuleService
.retrieveCurrency("usd")
res.json({
currency,
@@ -95,7 +97,8 @@ In this guide, youll find common examples of how you can use the Currency Mod
) {
const currencyModuleService = await initializeCurrencyModule()
const currency = await currencyModuleService.retrieve("usd")
const currency = await currencyModuleService
.retrieveCurrency("usd")
return NextResponse.json({ currency })
}
@@ -15,7 +15,9 @@ The Currency Module is the `@medusajs/currency` NPM package that provides curren
List and retrieve currencies stored in your application.
```ts
const currency = await currencyModuleService.retrieve("usd")
const currency = await currencyModuleService.retrieveCurrency(
"usd"
)
```
### Support Currencies in Modules
@@ -25,8 +27,10 @@ Other commerce modules use currency codes in their data models or operations. Yo
An example with the Region Module:
```ts
const region = await regionModuleService.retrieve("reg_123")
const currency = await currencyModuleService.retrieve(
const region = await regionModuleService.retrieveCurrency(
"reg_123"
)
const currency = await currencyModuleService.retrieveCurrency(
region.currency_code
)
```
@@ -55,7 +59,7 @@ For example:
req.scope.resolve(ModuleRegistrationName.CURRENCY)
res.json({
currencies: await currencyModuleService.list(),
currencies: await currencyModuleService.listCurrencies(),
})
}
```
@@ -74,7 +78,8 @@ For example:
const currencyModuleService: ICurrencyModuleService =
container.resolve(ModuleRegistrationName.CURRENCY)
const currencies = await currencyModuleService.list()
const currencies = await currencyModuleService
.listCurrencies()
}
```
@@ -94,7 +99,8 @@ For example:
ModuleRegistrationName.CURRENCY
)
const currencies = await currencyModuleService.list()
const currencies = await currencyModuleService
.listCurrencies()
})
```