docs: split events reference across modules (#10711)

* docs: split events reference across modules

* add lint exceptions
This commit is contained in:
Shahed Nasser
2024-12-24 09:54:51 +02:00
committed by GitHub
parent a4335f2a47
commit fd1afa8bc9
38 changed files with 1647 additions and 1301 deletions
@@ -0,0 +1,97 @@
import { Table } from "docs-ui"
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Event Name</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
`invite.accepted`
</Table.Cell>
<Table.Cell>
Emitted when an invite is accepted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
id, // The ID of the invite
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`invite.created`
</Table.Cell>
<Table.Cell>
Emitted when invites are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the invite
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`invite.deleted`
</Table.Cell>
<Table.Cell>
Emitted when invites are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the invite
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`invite.resent`
</Table.Cell>
<Table.Cell>
Emitted when invites are resent.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the invite
}]
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
@@ -0,0 +1,76 @@
import { Table } from "docs-ui"
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Event Name</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
`user.created`
</Table.Cell>
<Table.Cell>
Emitted when users are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the user
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`user.updated`
</Table.Cell>
<Table.Cell>
Emitted when users are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the user
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`user.deleted`
</Table.Cell>
<Table.Cell>
Emitted when users are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the user
}]
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
@@ -0,0 +1,20 @@
import InviteEvents from "./_content/invite.mdx"
import UserEvents from "./_content/user.mdx"
export const metadata = {
title: `User Module Events Reference`,
}
# {metadata.title}
This reference shows all the events emitted by the Medusa application related to the User Module. If you use the module outside the Medusa application, these events aren't emitted.
## Invite Events
<InviteEvents />
---
## User Events
<UserEvents />