Skip to content

Commit

Permalink
docs: split events reference across modules (#10711)
Browse files Browse the repository at this point in the history
* docs: split events reference across modules

* add lint exceptions
  • Loading branch information
shahednasser authored Dec 24, 2024
1 parent a4335f2 commit fd1afa8
Show file tree
Hide file tree
Showing 38 changed files with 1,647 additions and 1,301 deletions.
3 changes: 2 additions & 1 deletion www/apps/resources/.content.eslintrc.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ export default [
ignores: [
"**/references/**/*",
"**/events-reference/**/*",
"**/_events-table/**/*",
"**/events/_content/**/*",
"**/events/_content.mdx",
],
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ const CustomPage = () => {
const { data } = useQuery({
queryFn: () => sdk.admin.product.list({
limit,
offset
offset,
}),
queryKey: [["products", limit, offset]],
})
Expand Down Expand Up @@ -325,12 +325,12 @@ return (
columns={[
{
key: "id",
label: "ID"
label: "ID",
},
{
key: "title",
label: "Title"
}
label: "Title",
},
]}
data={data.products as any}
pageSize={data.limit}
Expand Down
36 changes: 36 additions & 0 deletions www/apps/resources/app/commerce-modules/auth/events/_content.mdx
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 www/apps/resources/app/commerce-modules/auth/events/page.mdx
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 www/apps/resources/app/commerce-modules/cart/events/_content.mdx
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 www/apps/resources/app/commerce-modules/cart/events/page.mdx
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 />
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 www/apps/resources/app/commerce-modules/customer/events/page.mdx
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 />
Loading

0 comments on commit fd1afa8

Please sign in to comment.