-
-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: split events reference across modules (#10711)
* docs: split events reference across modules * add lint exceptions
- Loading branch information
1 parent
a4335f2
commit fd1afa8
Showing
38 changed files
with
1,647 additions
and
1,301 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
36 changes: 36 additions & 0 deletions
36
www/apps/resources/app/commerce-modules/auth/events/_content.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
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> | ||
|
||
`auth.password_reset` | ||
|
||
</Table.Cell> | ||
<Table.Cell> | ||
|
||
Emitted when a password of a user, customer, or other actor types is reset. | ||
|
||
</Table.Cell> | ||
<Table.Cell> | ||
|
||
```ts blockStyle="inline" | ||
{ | ||
entity_id, // The user's identifier, such as their email | ||
token, // The reset token | ||
actor_type // `user`, `customer`, or custom type | ||
} | ||
``` | ||
|
||
</Table.Cell> | ||
</Table.Row> | ||
</Table.Body> | ||
</Table> |
11 changes: 11 additions & 0 deletions
11
www/apps/resources/app/commerce-modules/auth/events/page.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
import Content from "./_content.mdx" | ||
|
||
export const metadata = { | ||
title: `Auth Module Events Reference`, | ||
} | ||
|
||
# {metadata.title} | ||
|
||
This reference shows all the events emitted by the Medusa application related to the Auth Module. If you use the module outside the Medusa application, these events aren't emitted. | ||
|
||
<Content /> |
76 changes: 76 additions & 0 deletions
76
www/apps/resources/app/commerce-modules/cart/events/_content.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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> | ||
|
||
`cart.created` | ||
|
||
</Table.Cell> | ||
<Table.Cell> | ||
|
||
Emitted when a cart is created. | ||
|
||
</Table.Cell> | ||
<Table.Cell> | ||
|
||
```ts blockStyle="inline" | ||
{ | ||
id, // The ID of the cart | ||
} | ||
``` | ||
|
||
</Table.Cell> | ||
</Table.Row> | ||
<Table.Row> | ||
<Table.Cell> | ||
|
||
`cart.updated` | ||
|
||
</Table.Cell> | ||
<Table.Cell> | ||
|
||
Emitted when a cart is updated. This includes updates to its items, shipping methods, or information. | ||
|
||
</Table.Cell> | ||
<Table.Cell> | ||
|
||
```ts blockStyle="inline" | ||
{ | ||
id, // The ID of the customer | ||
} | ||
``` | ||
|
||
</Table.Cell> | ||
</Table.Row> | ||
<Table.Row> | ||
<Table.Cell> | ||
|
||
`cart.region_updated` | ||
|
||
</Table.Cell> | ||
<Table.Cell> | ||
|
||
Emitted when the region of a cart is updated. | ||
|
||
</Table.Cell> | ||
<Table.Cell> | ||
|
||
```ts blockStyle="inline" | ||
{ | ||
id, // The ID of the customer | ||
} | ||
``` | ||
|
||
</Table.Cell> | ||
</Table.Row> | ||
</Table.Body> | ||
</Table> |
11 changes: 11 additions & 0 deletions
11
www/apps/resources/app/commerce-modules/cart/events/page.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
import Content from "./_content.mdx" | ||
|
||
export const metadata = { | ||
title: `Cart Module Events Reference`, | ||
} | ||
|
||
# {metadata.title} | ||
|
||
This reference shows all the events emitted by the Medusa application related to the Cart Module. If you use the module outside the Medusa application, these events aren't emitted. | ||
|
||
<Content /> |
76 changes: 76 additions & 0 deletions
76
www/apps/resources/app/commerce-modules/customer/events/_content.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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> | ||
|
||
`customer.created` | ||
|
||
</Table.Cell> | ||
<Table.Cell> | ||
|
||
Emitted when customers are created. | ||
|
||
</Table.Cell> | ||
<Table.Cell> | ||
|
||
```ts blockStyle="inline" | ||
[{ | ||
id, // The ID of the customer | ||
}] | ||
``` | ||
|
||
</Table.Cell> | ||
</Table.Row> | ||
<Table.Row> | ||
<Table.Cell> | ||
|
||
`customer.updated` | ||
|
||
</Table.Cell> | ||
<Table.Cell> | ||
|
||
Emitted when customers are updated. | ||
|
||
</Table.Cell> | ||
<Table.Cell> | ||
|
||
```ts blockStyle="inline" | ||
[{ | ||
id, // The ID of the customer | ||
}] | ||
``` | ||
|
||
</Table.Cell> | ||
</Table.Row> | ||
<Table.Row> | ||
<Table.Cell> | ||
|
||
`customer.deleted` | ||
|
||
</Table.Cell> | ||
<Table.Cell> | ||
|
||
Emitted when customers are deleted. | ||
|
||
</Table.Cell> | ||
<Table.Cell> | ||
|
||
```ts blockStyle="inline" | ||
[{ | ||
id, // The ID of the customer | ||
}] | ||
``` | ||
|
||
</Table.Cell> | ||
</Table.Row> | ||
</Table.Body> | ||
</Table> |
11 changes: 11 additions & 0 deletions
11
www/apps/resources/app/commerce-modules/customer/events/page.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
import Content from "./_content.mdx" | ||
|
||
export const metadata = { | ||
title: `Customer Module Events Reference`, | ||
} | ||
|
||
# {metadata.title} | ||
|
||
This reference shows all the events emitted by the Medusa application related to the Customer Module. If you use the module outside the Medusa application, these events aren't emitted. | ||
|
||
<Content /> |
Oops, something went wrong.