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
@@ -91,7 +91,7 @@ In this guide, youll find common examples of how you can use the Tax Module i
)
res.json({
tax_regions: await taxModuleService.list(),
tax_regions: await taxModuleService.listTaxRegions(),
})
}
```
@@ -110,7 +110,7 @@ In this guide, youll find common examples of how you can use the Tax Module i
const taxModuleService = await initializeTaxModule()
return NextResponse.json({
tax_regions: await taxModuleService.list(),
tax_regions: await taxModuleService.listTaxRegions(),
})
}
```
@@ -138,7 +138,7 @@ In this guide, youll find common examples of how you can use the Tax Module i
ModuleRegistrationName.TAX
)
const taxRate = await taxModuleService.create({
const taxRate = await taxModuleService.createTaxRates({
tax_region_id: "txreg_123",
name: "Custom rate",
rate: 15,
@@ -175,7 +175,7 @@ In this guide, youll find common examples of how you can use the Tax Module i
) {
const taxModuleService = await initializeTaxModule()
const taxRate = await taxModuleService.create({
const taxRate = await taxModuleService.createTaxRates({
tax_region_id: "txreg_123",
name: "Custom rate",
rate: 15,
@@ -221,7 +221,7 @@ In this guide, youll find common examples of how you can use the Tax Module i
)
res.json({
tax_rates: await taxModuleService.list(),
tax_rates: await taxModuleService.listTaxRates(),
})
}
```
@@ -242,7 +242,7 @@ In this guide, youll find common examples of how you can use the Tax Module i
const taxModuleService = await initializeTaxModule()
return NextResponse.json({
tax_rates: await taxModuleService.list(),
tax_rates: await taxModuleService.listTaxRates(),
})
}
```
@@ -25,7 +25,7 @@ const taxRegion = await taxModuleService.createTaxRegions({
Manage each region's default tax rates and override them with conditioned tax rates.
```ts
const taxRates = await taxModuleService.create([
const taxRates = await taxModuleService.createTaxRates([
{
tax_region_id: "txreg_123",
name: "Default tax rate",
@@ -35,7 +35,7 @@ const taxLines = await taxModuleService.getTaxLines(
)
```
The context object is used to determine which tax regions and rates to use in the calculation. It includes fields related to the address and customer.
The context object is used to determine which tax regions and rates to use in the calculation. It includes properties related to the address and customer.
The example above returns the tax lines based on the tax region for the United States.
@@ -28,7 +28,7 @@ A tax region can have multiple tax rates, and each tax rate can have multiple ta
![A diagram showcasing the relation between TaxRegion, TaxRate, and TaxRateRule](https://res.cloudinary.com/dza7lstvk/image/upload/v1711462167/Medusa%20Resources/tax-rate-rule_enzbp2.jpg)
These two fields of the data model identify the rules target:
These two properties of the data model identify the rules target:
- `reference`: the name of the table in the database that this rule points to. For example, `product_type`.
- `reference_id`: the ID of the data models record that this points to. For example, a product types ID.