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
@@ -25,7 +25,7 @@ In this guide, youll find common examples of how you can use the User Module
const userModuleService: IUserModuleService =
req.scope.resolve(ModuleRegistrationName.USER)
const user = await userModuleService.create({
const user = await userModuleService.createUsers({
email: "user@example.com",
first_name: "John",
last_name: "Smith",
@@ -48,7 +48,7 @@ In this guide, youll find common examples of how you can use the User Module
export async function POST(request: Request) {
const userModuleService = await initializeUserModule()
const user = await userModuleService.create({
const user = await userModuleService.createUsers({
email: "user@example.com",
first_name: "John",
last_name: "Smith",
@@ -83,7 +83,7 @@ In this guide, youll find common examples of how you can use the User Module
req.scope.resolve(ModuleRegistrationName.USER)
res.json({
users: await userModuleService.list(),
users: await userModuleService.listUsers(),
})
}
```
@@ -102,7 +102,7 @@ In this guide, youll find common examples of how you can use the User Module
const userModuleService = await initializeUserModule()
return NextResponse.json({
users: await userModuleService.list(),
users: await userModuleService.listUsers(),
})
}
```
@@ -129,7 +129,7 @@ In this guide, youll find common examples of how you can use the User Module
const userModuleService: IUserModuleService =
req.scope.resolve(ModuleRegistrationName.USER)
const user = await userModuleService.update({
const user = await userModuleService.updateUsers({
id: "user_123",
last_name: "Smith",
})
@@ -153,7 +153,7 @@ In this guide, youll find common examples of how you can use the User Module
) {
const userModuleService = await initializeUserModule()
const user = await userModuleService.update({
const user = await userModuleService.updateUsers({
id: "user_123",
last_name: "Smith",
})
@@ -186,7 +186,7 @@ In this guide, youll find common examples of how you can use the User Module
const userModuleService: IUserModuleService =
req.scope.resolve(ModuleRegistrationName.USER)
await userModuleService.delete(["user_123"])
await userModuleService.deleteUsers(["user_123"])
}
```
@@ -205,7 +205,7 @@ In this guide, youll find common examples of how you can use the User Module
) {
const userModuleService = await initializeUserModule()
await userModuleService.delete(["user_123"])
await userModuleService.deleteUsers(["user_123"])
}
```
@@ -292,7 +292,7 @@ In this guide, youll find common examples of how you can use the User Module
const invite =
await userModuleService.validateInviteToken("secret_123")
const user = await userModuleService.create({
const user = await userModuleService.createUsers({
email: invite.email,
metadata: invite.metadata,
})
@@ -327,7 +327,7 @@ In this guide, youll find common examples of how you can use the User Module
const invite =
await userModuleService.validateInviteToken("secret_123")
const user = await userModuleService.create({
const user = await userModuleService.createUsers({
email: invite.email,
metadata: invite.metadata,
})