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

docs: split events reference across modules (#10711)

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files

3
www/apps/resources/.content.eslintrc.mjs
View File

@@ -22,7 +22,8 @@ export default [
ignores: [
"**/references/**/*",
"**/events-reference/**/*",
"**/_events-table/**/*",
"**/events/_content/**/*",
"**/events/_content.mdx",
],
},
{

8
www/apps/resources/app/admin-components/components/table/page.mdx
View File

@@ -281,7 +281,7 @@ const CustomPage = () => {
const { data } = useQuery({
queryFn: () => sdk.admin.product.list({
limit,
offset
offset,
}),
queryKey: [["products", limit, offset]],
})
@@ -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}

36
www/apps/resources/app/commerce-modules/auth/events/_content.mdx Normal file
View File

@@ -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
www/apps/resources/app/commerce-modules/auth/events/page.mdx Normal file
View File

@@ -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
www/apps/resources/app/commerce-modules/cart/events/_content.mdx Normal file
View File

@@ -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
www/apps/resources/app/commerce-modules/cart/events/page.mdx Normal file
View File

@@ -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
www/apps/resources/app/commerce-modules/customer/events/_content.mdx Normal file
View File

@@ -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
www/apps/resources/app/commerce-modules/customer/events/page.mdx Normal file
View File

@@ -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 />

251
www/apps/resources/app/commerce-modules/order/events/_content.mdx Normal file
View File

@@ -0,0 +1,251 @@
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>
`order.placed`
</Table.Cell>
<Table.Cell>
Emitted when the customer completes a cart and an order is placed.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
id, // The ID of the order
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order.canceled`
</Table.Cell>
<Table.Cell>
Emitted when an order is canceled.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
id, // The ID of the order
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order.completed`
</Table.Cell>
<Table.Cell>
Emitted when orders are completed.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the order
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order.archived`
</Table.Cell>
<Table.Cell>
Emitted when orders are archived.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the order
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order.fulfillment_created`
</Table.Cell>
<Table.Cell>
Emitted when a fulfillment is created for an order.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
order_id, // The ID of the order
fulfillment_id, // The ID of the fulfillment
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order.fulfillment_canceled`
</Table.Cell>
<Table.Cell>
Emitted when a fulfillment is canceled for an order.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
order_id, // The ID of the order
fulfillment_id, // The ID of the fulfillment
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order.return_requested`
</Table.Cell>
<Table.Cell>
Emitted when a return is requested.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
order_id, // The ID of the order
return_id, // The ID of the return
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order.return_received`
</Table.Cell>
<Table.Cell>
Emitted when a return is received.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
order_id, // The ID of the order
return_id, // The ID of the return
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order.claim_created`
</Table.Cell>
<Table.Cell>
Emitted when a claim is created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
order_id, // The ID of the order
claim_id, // The ID of the claim
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order.exchange_created`
</Table.Cell>
<Table.Cell>
Emitted when an exchange is created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
order_id, // The ID of the order
exchange_id, // The ID of the exchange
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order.transfer_requested`
</Table.Cell>
<Table.Cell>
Emitted when an order transfer is requested. This is available from [Medusa v2.0.5+](https://github.com/medusajs/medusa/releases/tag/v2.0.5).
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
{
order_id, // The ID of the order
exchange_id, // The ID of the exchange
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>

11
www/apps/resources/app/commerce-modules/order/events/page.mdx Normal file
View File

@@ -0,0 +1,11 @@
import Content from "./_content.mdx"
export const metadata = {
title: `Order Module Events Reference`,
}
# {metadata.title}
This reference shows all the events emitted by the Medusa application related to the Order Module. If you use the module outside the Medusa application, these events aren't emitted.
<Content />

76
www/apps/resources/app/commerce-modules/product/events/_content/product-category.mdx Normal file
View File

@@ -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>
`product-category.created`
</Table.Cell>
<Table.Cell>
Emitted when product categories are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the category
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product-category.updated`
</Table.Cell>
<Table.Cell>
Emitted when product categories are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the category
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product-category.deleted`
</Table.Cell>
<Table.Cell>
Emitted when product categories are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the category
}]
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>

76
www/apps/resources/app/commerce-modules/product/events/_content/product-collection.mdx Normal file
View File

@@ -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>
`product-collection.created`
</Table.Cell>
<Table.Cell>
Emitted when product collections are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the collection
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product-collection.updated`
</Table.Cell>
<Table.Cell>
Emitted when product collections are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the collection
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product-collection.deleted`
</Table.Cell>
<Table.Cell>
Emitted when product collections are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the collection
}]
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>

76
www/apps/resources/app/commerce-modules/product/events/_content/product-option.mdx Normal file
View File

@@ -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>
`product-option.created`
</Table.Cell>
<Table.Cell>
Emitted when product options are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the option
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product-option.updated`
</Table.Cell>
<Table.Cell>
Emitted when product options are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the option
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product-option.deleted`
</Table.Cell>
<Table.Cell>
Emitted when product options are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the option
}]
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>

76
www/apps/resources/app/commerce-modules/product/events/_content/product-tag.mdx Normal file
View File

@@ -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>
`product-tag.created`
</Table.Cell>
<Table.Cell>
Emitted when product tags are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the tag
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product-tag.updated`
</Table.Cell>
<Table.Cell>
Emitted when product tags are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the tag
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product-tag.deleted`
</Table.Cell>
<Table.Cell>
Emitted when product tags are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the tag
}]
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>

76
www/apps/resources/app/commerce-modules/product/events/_content/product-type.mdx Normal file
View File

@@ -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>
`product-type.created`
</Table.Cell>
<Table.Cell>
Emitted when product types are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the type
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product-type.updated`
</Table.Cell>
<Table.Cell>
Emitted when product types are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the type
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product-type.deleted`
</Table.Cell>
<Table.Cell>
Emitted when product types are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the type
}]
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>

76
www/apps/resources/app/commerce-modules/product/events/_content/product-variant.mdx Normal file
View File

@@ -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>
`product-variant.created`
</Table.Cell>
<Table.Cell>
Emitted when product variants are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the variant
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product-variant.updated`
</Table.Cell>
<Table.Cell>
Emitted when product variants are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the variant
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product-variant.deleted`
</Table.Cell>
<Table.Cell>
Emitted when product variants are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the variant
}]
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>

76
www/apps/resources/app/commerce-modules/product/events/_content/product.mdx Normal file
View File

@@ -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>
`product.created`
</Table.Cell>
<Table.Cell>
Emitted when products are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the product
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product.updated`
</Table.Cell>
<Table.Cell>
Emitted when products are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the product
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product.deleted`
</Table.Cell>
<Table.Cell>
Emitted when products are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the product
}]
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>

55
www/apps/resources/app/commerce-modules/product/events/page.mdx Normal file
View File

@@ -0,0 +1,55 @@
import ProductEvents from "./_content/product.mdx"
import ProductCategoryEvents from "./_content/product-category.mdx"
import ProductCollectionEvents from "./_content/product-collection.mdx"
import ProductOptionEvents from "./_content/product-option.mdx"
import ProductTagEvents from "./_content/product-tag.mdx"
import ProductTypeEvents from "./_content/product-type.mdx"
import ProductVariantEvents from "./_content/product-variant.mdx"
export const metadata = {
title: `Product Module Events Reference`,
}
# {metadata.title}
This reference shows all the events emitted by the Medusa application related to the Product Module. If you use the module outside the Medusa application, these events aren't emitted.
## Product Events
<ProductEvents />
---
## Product Category Events
<ProductCategoryEvents />
---
## Product Collection Events
<ProductCollectionEvents />
---
## Product Option Events
<ProductOptionEvents />
---
## Product Tag Events
<ProductTagEvents />
---
## Product Type Events
<ProductTypeEvents />
---
## Product Variant Events
<ProductVariantEvents />

76
www/apps/resources/app/commerce-modules/region/events/_content.mdx Normal file
View File

@@ -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>
`region.created`
</Table.Cell>
<Table.Cell>
Emitted when regions are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the region
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`region.updated`
</Table.Cell>
<Table.Cell>
Emitted when regions are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the region
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`region.deleted`
</Table.Cell>
<Table.Cell>
Emitted when regions are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the region
}]
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>

11
www/apps/resources/app/commerce-modules/region/events/page.mdx Normal file
View File

@@ -0,0 +1,11 @@
import Content from "./_content.mdx"
export const metadata = {
title: `Region Module Events Reference`,
}
# {metadata.title}
This reference shows all the events emitted by the Medusa application related to the Region Module. If you use the module outside the Medusa application, these events aren't emitted.
<Content />

76
www/apps/resources/app/commerce-modules/sales-channel/events/_content.mdx Normal file
View File

@@ -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>
`sales-channel.created`
</Table.Cell>
<Table.Cell>
Emitted when sales channels are created.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the sales channel
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`sales-channel.updated`
</Table.Cell>
<Table.Cell>
Emitted when sales channels are updated.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the sales channel
}]
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`sales-channel.deleted`
</Table.Cell>
<Table.Cell>
Emitted when sales channels are deleted.
</Table.Cell>
<Table.Cell>
```ts blockStyle="inline"
[{
id, // The ID of the sales channel
}]
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>

11
www/apps/resources/app/commerce-modules/sales-channel/events/page.mdx Normal file
View File

@@ -0,0 +1,11 @@
import Content from "./_content.mdx"
export const metadata = {
title: `Sales Channel Module Events Reference`,
}
# {metadata.title}
This reference shows all the events emitted by the Medusa application related to the Sales Channel Module. If you use the module outside the Medusa application, these events aren't emitted.
<Content />

97
www/apps/resources/app/commerce-modules/user/events/_content/invite.mdx Normal file
View File

@@ -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>

76
www/apps/resources/app/commerce-modules/user/events/_content/user.mdx Normal file
View File

@@ -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>

20
www/apps/resources/app/commerce-modules/user/events/page.mdx Normal file
View File

@@ -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 />

1296
www/apps/resources/app/events-reference/page.mdx
View File

File diff suppressed because it is too large Load Diff

56
www/apps/resources/app/integrations/guides/shipstation/page.mdx
View File

@@ -247,9 +247,9 @@ export class ShipStationClient {
...data,
headers: {
...data?.headers,
'api-key': this.options.api_key,
"Content-Type": "application/json"
}
"api-key": this.options.api_key,
"Content-Type": "application/json",
},
}).then((resp) => {
const contentType = resp.headers.get("content-type")
if (!contentType?.includes("application/json")) {
@@ -416,7 +416,7 @@ class ShipStationProviderService extends AbstractFulfillmentProviderService {
id: `${carrier.carrier_id}__${service.service_code}`,
name: service.name,
carrier_id: carrier.carrier_id,
carrier_service_code: service.service_code
carrier_service_code: service.service_code,
})
})
})
@@ -606,7 +606,7 @@ export class ShipStationClient {
): Promise<GetShippingRatesResponse> {
return await this.sendRequest("/rates", {
method: "POST",
body: JSON.stringify(data)
body: JSON.stringify(data),
}).then((resp) => {
if (resp.rate_response.errors?.length) {
throw new MedusaError(
@@ -643,7 +643,7 @@ export const serviceHighlights8 = [
// other imports...
import {
// ...
MedusaError
MedusaError,
} from "@medusajs/framework/utils"
import {
// ...
@@ -651,7 +651,7 @@ import {
} from "@medusajs/framework/types"
import {
GetShippingRatesResponse,
ShipStationAddress
ShipStationAddress,
} from "./types"
class ShipStationProviderService extends AbstractFulfillmentProviderService {
@@ -662,7 +662,7 @@ class ShipStationProviderService extends AbstractFulfillmentProviderService {
from_address,
to_address,
items,
currency_code
currency_code,
}: {
carrier_id: string
carrier_service_code: string
@@ -692,7 +692,7 @@ class ShipStationProviderService extends AbstractFulfillmentProviderService {
state_province: from_address?.address?.province || "",
postal_code: from_address?.address?.postal_code || "",
country_code: from_address?.address?.country_code || "",
address_residential_indicator: "unknown"
address_residential_indicator: "unknown",
}
if (!to_address) {
throw new MedusaError(
@@ -709,7 +709,7 @@ class ShipStationProviderService extends AbstractFulfillmentProviderService {
state_province: to_address.province || "",
postal_code: to_address.postal_code || "",
country_code: to_address.country_code || "",
address_residential_indicator: "unknown"
address_residential_indicator: "unknown",
}
// TODO create shipment
@@ -748,24 +748,24 @@ return await this.client.getShippingRates({
items: items?.map((item) => ({
name: item.title,
quantity: item.quantity,
sku: item.variant_sku || ""
sku: item.variant_sku || "",
})),
packages: [{
weight: {
value: packageWeight,
unit: "kilogram"
}
unit: "kilogram",
},
}],
customs: {
contents: "merchandise",
non_delivery: "return_to_sender"
}
non_delivery: "return_to_sender",
},
},
rate_options: {
carrier_ids: [carrier_id],
service_codes: [carrier_service_code],
preferred_currency: currency_code as string,
}
},
})
```
@@ -816,11 +816,11 @@ class ShipStationProviderService extends AbstractFulfillmentProviderService {
carrier_service_code,
from_address: {
name: context.from_location?.name,
address: context.from_location?.address
address: context.from_location?.address,
},
to_address: context.shipping_address,
items: context.items || [],
currency_code: context.currency_code
currency_code: context.currency_code,
})
rate = shipment.rate_response.rates[0]
} else {
@@ -834,7 +834,7 @@ class ShipStationProviderService extends AbstractFulfillmentProviderService {
return {
calculated_amount: calculatedPrice,
is_calculated_price_tax_inclusive: !!rate?.tax_amount
is_calculated_price_tax_inclusive: !!rate?.tax_amount,
}
}
}
@@ -901,21 +901,21 @@ class ShipStationProviderService extends AbstractFulfillmentProviderService {
// @ts-ignore
name: context.from_location?.name,
// @ts-ignore
address: context.from_location?.address
address: context.from_location?.address,
},
// @ts-ignore
to_address: context.shipping_address,
// @ts-ignore
items: context.items || [],
// @ts-ignore
currency_code: context.currency_code
currency_code: context.currency_code,
})
shipment_id = shipment.shipment_id
}
return {
...data,
shipment_id
shipment_id,
}
}
}
@@ -994,7 +994,7 @@ export class ShipStationClient {
async purchaseLabelForShipment(id: string): Promise<Label> {
return await this.sendRequest(`/labels/shipment/${id}`, {
method: "POST",
body: JSON.stringify({})
body: JSON.stringify({}),
})
}
}
@@ -1043,7 +1043,7 @@ class ShipStationProviderService extends AbstractFulfillmentProviderService {
orderItemsToFulfill.push({
...orderItem,
// @ts-ignore
quantity: item.quantity
quantity: item.quantity,
})
})
@@ -1057,7 +1057,7 @@ class ShipStationProviderService extends AbstractFulfillmentProviderService {
address_1: originalShipment.ship_from.address_line1,
city: originalShipment.ship_from.city_locality,
province: originalShipment.ship_from.state_province,
}
},
},
to_address: {
...originalShipment.ship_to,
@@ -1067,7 +1067,7 @@ class ShipStationProviderService extends AbstractFulfillmentProviderService {
},
items: orderItemsToFulfill as OrderLineItemDTO[],
// @ts-ignore
currency_code: order.currency_code
currency_code: order.currency_code,
})
const label = await this.client.purchaseLabelForShipment(newShipment.shipment_id)
@@ -1076,7 +1076,7 @@ class ShipStationProviderService extends AbstractFulfillmentProviderService {
data: {
...(fulfillment.data as object || {}),
label_id: label.label_id,
shipment_id: label.shipment_id
shipment_id: label.shipment_id,
},
}
}
@@ -1228,7 +1228,7 @@ module.exports = defineConfig({
resolve: "./src/modules/shipstation",
id: "shipstation",
options: {
api_key: process.env.SHIPSTATION_API_KEY
api_key: process.env.SHIPSTATION_API_KEY,
},
},
],

12
www/apps/resources/generated/edit-dates.mjs
View File

@@ -3384,7 +3384,7 @@ export const generatedEditDates = {
"references/types/DmlTypes/types/types.DmlTypes.InferForeignKeys/page.mdx": "2024-12-23T12:30:28.159Z",
"references/types/DmlTypes/types/types.DmlTypes.InferSchemaFields/page.mdx": "2024-12-10T14:54:55.447Z",
"references/types/interfaces/types.BaseRepositoryService/page.mdx": "2024-12-09T13:21:32.969Z",
"app/events-reference/page.mdx": "2024-11-27T13:31:07.385Z",
"app/events-reference/page.mdx": "2024-12-23T16:30:48.569Z",
"references/auth_models/variables/auth_models.AuthIdentity/page.mdx": "2024-12-23T13:57:08.092Z",
"references/auth_models/variables/auth_models.ProviderIdentity/page.mdx": "2024-12-23T13:57:08.094Z",
"references/dml/entity/DmlEntity/methods/dml.entity.DmlEntity.checks/page.mdx": "2024-12-09T13:21:55.464Z",
@@ -5756,5 +5756,13 @@ export const generatedEditDates = {
"references/core_flows/core_flows.Tax/page.mdx": "2024-12-23T12:30:26.503Z",
"references/core_flows/core_flows.User/page.mdx": "2024-12-23T12:30:26.564Z",
"references/order/types/order.ReturnStatus/page.mdx": "2024-12-23T12:30:30.107Z",
"references/fulfillment_models/types/fulfillment_models.ServiceZoneSchema/page.mdx": "2024-12-23T12:30:32.004Z"
"references/fulfillment_models/types/fulfillment_models.ServiceZoneSchema/page.mdx": "2024-12-23T12:30:32.004Z",
"app/commerce-modules/auth/events/page.mdx": "2024-12-23T16:16:08.118Z",
"app/commerce-modules/cart/events/page.mdx": "2024-12-23T16:16:47.466Z",
"app/commerce-modules/customer/events/page.mdx": "2024-12-23T16:17:25.414Z",
"app/commerce-modules/order/events/page.mdx": "2024-12-23T16:19:41.929Z",
"app/commerce-modules/product/events/page.mdx": "2024-12-23T16:25:05.789Z",
"app/commerce-modules/region/events/page.mdx": "2024-12-23T16:26:13.661Z",
"app/commerce-modules/sales-channel/events/page.mdx": "2024-12-23T16:27:10.675Z",
"app/commerce-modules/user/events/page.mdx": "2024-12-23T16:28:41.193Z"
}

32
www/apps/resources/generated/files-map.mjs
View File

@@ -167,6 +167,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/auth/create-actor-type/page.mdx",
"pathname": "/commerce-modules/auth/create-actor-type"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/auth/events/page.mdx",
"pathname": "/commerce-modules/auth/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/auth/examples/page.mdx",
"pathname": "/commerce-modules/auth/examples"
@@ -187,6 +191,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/cart/concepts/page.mdx",
"pathname": "/commerce-modules/cart/concepts"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/cart/events/page.mdx",
"pathname": "/commerce-modules/cart/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/cart/examples/page.mdx",
"pathname": "/commerce-modules/cart/examples"
@@ -223,6 +231,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/customer/customer-accounts/page.mdx",
"pathname": "/commerce-modules/customer/customer-accounts"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/customer/events/page.mdx",
"pathname": "/commerce-modules/customer/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/customer/examples/page.mdx",
"pathname": "/commerce-modules/customer/examples"
@@ -295,6 +307,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/order/edit/page.mdx",
"pathname": "/commerce-modules/order/edit"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/order/events/page.mdx",
"pathname": "/commerce-modules/order/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/order/exchange/page.mdx",
"pathname": "/commerce-modules/order/exchange"
@@ -407,6 +423,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/pricing/tax-inclusive-pricing/page.mdx",
"pathname": "/commerce-modules/pricing/tax-inclusive-pricing"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/product/events/page.mdx",
"pathname": "/commerce-modules/product/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/product/examples/page.mdx",
"pathname": "/commerce-modules/product/examples"
@@ -463,6 +483,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/promotion/page.mdx",
"pathname": "/commerce-modules/promotion"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/region/events/page.mdx",
"pathname": "/commerce-modules/region/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/region/examples/page.mdx",
"pathname": "/commerce-modules/region/examples"
@@ -475,6 +499,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/region/page.mdx",
"pathname": "/commerce-modules/region"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/sales-channel/events/page.mdx",
"pathname": "/commerce-modules/sales-channel/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/sales-channel/examples/page.mdx",
"pathname": "/commerce-modules/sales-channel/examples"
@@ -539,6 +567,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/tax/tax-region/page.mdx",
"pathname": "/commerce-modules/tax/tax-region"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/user/events/page.mdx",
"pathname": "/commerce-modules/user/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/user/examples/page.mdx",
"pathname": "/commerce-modules/user/examples"

64
www/apps/resources/generated/sidebar.mjs
View File

@@ -496,6 +496,14 @@ export const generatedSidebar = [
"type": "sub-category",
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/auth/events",
"title": "Events Reference",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -753,6 +761,14 @@ export const generatedSidebar = [
"type": "sub-category",
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/cart/events",
"title": "Events Reference",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -1427,6 +1443,14 @@ export const generatedSidebar = [
"type": "sub-category",
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/customer/events",
"title": "Events Reference",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -3015,6 +3039,14 @@ export const generatedSidebar = [
"type": "sub-category",
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/order/events",
"title": "Events Reference",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -5389,6 +5421,14 @@ export const generatedSidebar = [
"type": "sub-category",
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/product/events",
"title": "Events Reference",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -6522,6 +6562,14 @@ export const generatedSidebar = [
"type": "sub-category",
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/region/events",
"title": "Events Reference",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -6731,6 +6779,14 @@ export const generatedSidebar = [
"type": "sub-category",
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/sales-channel/events",
"title": "Events Reference",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -7583,6 +7639,14 @@ export const generatedSidebar = [
"type": "sub-category",
"title": "References",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/user/events",
"title": "Events Reference",
"children": []
},
{
"loaded": true,
"isPathHref": true,

5
www/apps/resources/sidebars/auth.mjs
View File

@@ -92,6 +92,11 @@ export const authSidebar = [
type: "sub-category",
title: "References",
children: [
{
type: "link",
path: "/commerce-modules/auth/events",
title: "Events Reference",
},
{
type: "link",
path: "/references/auth",

5
www/apps/resources/sidebars/cart.mjs
View File

@@ -50,6 +50,11 @@ export const cartSidebar = [
type: "sub-category",
title: "References",
children: [
{
type: "link",
path: "/commerce-modules/cart/events",
title: "Events Reference",
},
{
type: "link",
path: "/references/cart",

5
www/apps/resources/sidebars/customer.mjs
View File

@@ -35,6 +35,11 @@ export const customerSidebar = [
type: "sub-category",
title: "References",
children: [
{
type: "link",
path: "/commerce-modules/customer/events",
title: "Events Reference",
},
{
type: "link",
path: "/references/customer",

5
www/apps/resources/sidebars/order-module.mjs
View File

@@ -75,6 +75,11 @@ export const orderSidebar = [
type: "sub-category",
title: "References",
children: [
{
type: "link",
path: "/commerce-modules/order/events",
title: "Events Reference",
},
{
type: "link",
path: "/references/order",

5
www/apps/resources/sidebars/product.mjs
View File

@@ -40,6 +40,11 @@ export const productSidebar = [
type: "sub-category",
title: "References",
children: [
{
type: "link",
path: "/commerce-modules/product/events",
title: "Events Reference",
},
{
type: "link",
path: "/references/product",

5
www/apps/resources/sidebars/region.mjs
View File

@@ -30,6 +30,11 @@ export const regionSidebar = [
type: "sub-category",
title: "References",
children: [
{
type: "link",
path: "/commerce-modules/region/events",
title: "Events Reference",
},
{
type: "link",
path: "/references/region",

5
www/apps/resources/sidebars/sales-channel.mjs
View File

@@ -35,6 +35,11 @@ export const salesChannelSidebar = [
type: "sub-category",
title: "References",
children: [
{
type: "link",
path: "/commerce-modules/sales-channel/events",
title: "Events Reference",
},
{
type: "link",
path: "/references/sales-channel",

5
www/apps/resources/sidebars/user.mjs
View File

@@ -35,6 +35,11 @@ export const userSidebar = [
type: "sub-category",
title: "References",
children: [
{
type: "link",
path: "/commerce-modules/user/events",
title: "Events Reference",
},
{
type: "link",
path: "/references/user",