asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: document events reference (#9080)

Browse Source 
- Remove old hidden reference files that document modules' events
- Add new events reference for workflow events
- Reference events reference in the main docs
This commit is contained in:
Shahed Nasser
2024-09-10 12:20:09 +00:00
committed by GitHub
parent 3fb2f10ccb
commit 4b663a4559
42 changed files with 843 additions and 3025 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/app/commerce-modules/user/_events/_events-table/page.mdx
-167
View File
@@ -1,167 +0,0 @@
import { Table } from "docs-ui"
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Event Name</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>Data Payload</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`user.created`
</Table.Cell>
<Table.Cell>
Triggered when a user is created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
// the ID of the user
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`user.updated`
</Table.Cell>
<Table.Cell>
Triggered when a user is updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
// the ID of the user
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`user.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a user is deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
// the ID of the deleted user
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`invite.created`
</Table.Cell>
<Table.Cell>
Triggered when an invite is created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
// the ID of the invite
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`invite.updated`
</Table.Cell>
<Table.Cell>
Triggered when an invite is updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
// the ID of the invite
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`invite.deleted`
</Table.Cell>
<Table.Cell>
Triggered when an invite is deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
// the ID of the deleted invite
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`invite.token_generated`
</Table.Cell>
<Table.Cell>
Triggered when an invite's token is generated for the first time or refreshed.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
// the ID of the invite
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/user/_events/page.mdx
-17
View File
@@ -1,17 +0,0 @@
import EventsTable from "./_events-table/page.mdx"
export const metadata = {
title: `User Module Events Reference`,
}
# {metadata.title}
Find in this reference the list of events emitted by the User Module.
<Note type="soon">
Events are still in development, so this reference will change in the future.
</Note>
<EventsTable />