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

docs: update events reference (#7321)

Browse Source 
* change subscribers events

* add event references for modules
This commit is contained in:
Shahed Nasser
2024-05-16 10:01:12 +03:00
committed by GitHub
parent 1160a34f3d
commit 9b1998b9b2
44 changed files with 2995 additions and 3280 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/book/app/advanced-development/events-and-subscribers/data-payload/page.mdx
+2 -3
View File
@@ -21,7 +21,6 @@ export const highlights = [
```ts title="src/subscribers/product-created.ts" highlights={highlights}
import {
ProductService,
SubscriberArgs,
type SubscriberConfig,
} from "@medusajs/medusa"
@@ -33,11 +32,11 @@ export default async function productCreateHandler({
}
export const config: SubscriberConfig = {
event: ProductService.Events.CREATED,
event: "product.created",
}
```
This logs the product ID received in the `ProductService.Events.CREATED` (`product-created`) event’s data payload to the console.
This logs the product ID received in the `product.created` event’s data payload to the console.
## List of Events with Data Payload
www/apps/book/app/basics/events-and-subscribers/page.mdx
+4 -8
View File
@@ -21,10 +21,7 @@ The subscriber is created in a TypeScript or JavaScript file under the `src/subs
For example, create the file `src/subscribers/product-created.ts` with the following content:
```ts title="src/subscribers/product-created.ts"
import {
ProductService,
type SubscriberConfig,
} from "@medusajs/medusa"
import { type SubscriberConfig } from "@medusajs/medusa"
// subscriber function
export default async function productCreateHandler() {
@@ -33,7 +30,7 @@ export default async function productCreateHandler() {
// subscriber config
export const config: SubscriberConfig = {
event: ProductService.Events.CREATED,
event: "product.created",
}
```
@@ -42,7 +39,7 @@ A subscriber file must export:
- The subscriber function that is an asynchronous function executed whenever the associated event is triggered.
- A configuration object defining the event this subscriber is listening to.
The above subscriber listens to the `ProductService.Events.CREATED` (`product-created`) event. Whenever the event is emitted, it logs in the terminal `A product is created`.
The above subscriber listens to the `product.created` event. Whenever the event is emitted, it logs in the terminal `A product is created`.
{/* TODO add when we have the admin dashboard to use with V2 for easy testing. */}
@@ -91,7 +88,6 @@ export const highlights = [
```ts title="src/subscribers/product-created.ts" highlights={highlights}
import {
ProductService,
SubscriberArgs,
type SubscriberConfig,
} from "@medusajs/medusa"
@@ -111,7 +107,7 @@ export default async function productCreateHandler({
}
export const config: SubscriberConfig = {
event: ProductService.Events.CREATED,
event: `product.created`,
}
```
www/apps/resources/app/commerce-modules/api-key/events/_events-table/page.mdx
+35
View File
@@ -0,0 +1,35 @@
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>
<Table.Cell>
`api-key.deleted`
</Table.Cell>
<Table.Cell>
Triggered when an API key is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted API key
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/api-key/events/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import EventsTable from "./_events-table/page.mdx"
export const metadata = {
title: `API Key Module Events Reference`,
}
# {metadata.title}
Find in this reference the list of events emitted by the API Key Module.
<EventsTable />
www/apps/resources/app/commerce-modules/auth/events/_events-table/page.mdx
+35
View File
@@ -0,0 +1,35 @@
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>
<Table.Cell>
`auth.deleted`
</Table.Cell>
<Table.Cell>
Triggered when an auth user is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted auth user
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/auth/events/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import EventsTable from "./_events-table/page.mdx"
export const metadata = {
title: `Auth Module Events Reference`,
}
# {metadata.title}
Find in this reference the list of events emitted by the Auth Module.
<EventsTable />
www/apps/resources/app/commerce-modules/cart/events/_events-table/page.mdx
+189
View File
@@ -0,0 +1,189 @@
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>
<Table.Cell>
`cart.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a cart is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted cart
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`address.deleted`
</Table.Cell>
<Table.Cell>
Triggered when an address is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted address
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`line-item.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a line item is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted line item
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`line-item-adjustment.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a line item adjustment is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted line item adjustment
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`line-item-tax-line.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a line item tax line is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted line item tax line
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`shipping-method.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a shipping method is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted shipping method
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`shipping-method-adjustment.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a shipping method adjustment is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted shipping method adjustment
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`shipping-method-tax-line.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a shipping method tax line is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted shipping method tax line
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/cart/events/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import EventsTable from "./_events-table/page.mdx"
export const metadata = {
title: `Cart Module Events Reference`,
}
# {metadata.title}
Find in this reference the list of events emitted by the Cart Module.
<EventsTable />
www/apps/resources/app/commerce-modules/currency/events/_events-table/page.mdx
+35
View File
@@ -0,0 +1,35 @@
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>
<Table.Cell>
`currency.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a currency is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted currency
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/currency/events/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import EventsTable from "./_events-table/page.mdx"
export const metadata = {
title: `Currency Module Events Reference`,
}
# {metadata.title}
Find in this reference the list of events emitted by the Currency Module.
<EventsTable />
www/apps/resources/app/commerce-modules/customer/events/_events-table/page.mdx
+101
View File
@@ -0,0 +1,101 @@
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>
<Table.Cell>
`customer.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a customer is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted customer
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`address.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a address is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted address
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`customer-group.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a customer group is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted customer group
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`customer-group-customer.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a customer group customer (the data model of the relation between customer groups and customers) is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted customer group customer
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/customer/events/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import EventsTable from "./_events-table/page.mdx"
export const metadata = {
title: `Customer Module Events Reference`,
}
# {metadata.title}
Find in this reference the list of events emitted by the Customer Module.
<EventsTable />
www/apps/resources/app/commerce-modules/fulfillment/events/_events-table/page.mdx
+255
View File
@@ -0,0 +1,255 @@
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>
`fulfillment-set.created`
</Table.Cell>
<Table.Cell>
Triggered when a fulfillment set is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the fulfillment set
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`fulfillment-set.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a fulfillment set is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted fulfillment set
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`service-zone.created`
</Table.Cell>
<Table.Cell>
Triggered when a service zone is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the service zone
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`service-zone.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a service zone is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted service zone
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`geo-zone.created`
</Table.Cell>
<Table.Cell>
Triggered when a geo zone is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the geo zone
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`geo-zone.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a geo zone is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted geo zone
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`shipping-option.created`
</Table.Cell>
<Table.Cell>
Triggered when a shipping option is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the shipping option
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`shipping-profile.created`
</Table.Cell>
<Table.Cell>
Triggered when a shipping profile is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the shipping profile
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`shipping-option-rule.created`
</Table.Cell>
<Table.Cell>
Triggered when a shipping option rule is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the shipping option rule
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`shipping-option-type.created`
</Table.Cell>
<Table.Cell>
Triggered when a shipping option type is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the shipping option type
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`fulfillment-provider.created`
</Table.Cell>
<Table.Cell>
Triggered when a fulfillment provider is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the fulfillment provider
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/fulfillment/events/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import EventsTable from "./_events-table/page.mdx"
export const metadata = {
title: `Fulfillment Module Events Reference`,
}
# {metadata.title}
Find in this reference the list of events emitted by the Fulfillment Module.
<EventsTable />
www/apps/resources/app/commerce-modules/inventory/events/_events-table/page.mdx
+211
View File
@@ -0,0 +1,211 @@
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>
`inventory-item.created`
</Table.Cell>
<Table.Cell>
Triggered when a inventory item is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the inventory item
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`inventory-item.updated`
</Table.Cell>
<Table.Cell>
Triggered when a inventory item is updated.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the inventory item
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`inventory-item.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a inventory item is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted inventory item
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`inventory-level.created`
</Table.Cell>
<Table.Cell>
Triggered when a inventory level is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the inventory level
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`inventory-level.updated`
</Table.Cell>
<Table.Cell>
Triggered when a inventory level is updated.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the inventory level
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`inventory-level.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a inventory level is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted inventory level
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`reservation-item.created`
</Table.Cell>
<Table.Cell>
Triggered when a reservation item is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the reservation item
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`reservation-item.updated`
</Table.Cell>
<Table.Cell>
Triggered when a reservation item is updated.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the reservation item
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`reservation-item.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a reservation item is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted reservation item
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/inventory/events/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import EventsTable from "./_events-table/page.mdx"
export const metadata = {
title: `Inventory Module Events Reference`,
}
# {metadata.title}
Find in this reference the list of events emitted by the Inventory Module.
<EventsTable />
www/apps/resources/app/commerce-modules/order/events/_events-table/page.mdx
+321
View File
@@ -0,0 +1,321 @@
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>
<Table.Cell>
`order.deleted`
</Table.Cell>
<Table.Cell>
Triggered when an order is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted order
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`address.deleted`
</Table.Cell>
<Table.Cell>
Triggered when an address is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted address
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`line-item.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a line item is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted line item
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`line-item-adjustment.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a line item adjustment is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted line item adjustment
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`line-item-tax-line.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a line item tax line is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted line item tax line
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`shipping-method.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a shipping method is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted shipping method
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`shipping-method-adjustment.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a shipping method adjustment is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted shipping method adjustment
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`shipping-method-tax-line.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a shipping method tax line is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted shipping method tax line
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`transaction.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a transaction is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted transaction
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order-change.deleted`
</Table.Cell>
<Table.Cell>
Triggered when an order change is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted order change
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order-change-action.deleted`
</Table.Cell>
<Table.Cell>
Triggered when an order change action is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted order change action
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order-item.deleted`
</Table.Cell>
<Table.Cell>
Triggered when an order item is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted order item
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order-summary.deleted`
</Table.Cell>
<Table.Cell>
Triggered when an order summary is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted order summary
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`order-shipping-method.deleted`
</Table.Cell>
<Table.Cell>
Triggered when an order shipping method is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted order shipping method
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/order/events/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import EventsTable from "./_events-table/page.mdx"
export const metadata = {
title: `Order Module Events Reference`,
}
# {metadata.title}
Find in this reference the list of events emitted by the Order Module.
<EventsTable />
www/apps/resources/app/commerce-modules/payment/events/_events-table/page.mdx
+123
View File
@@ -0,0 +1,123 @@
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>
<Table.Cell>
`payment.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a payment is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted payment
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`payment-collection.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a payment collection is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted payment collection
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`payment-session.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a payment session is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted payment session
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`capture.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a capture is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted capture
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`refund.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a refund is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted refund
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/payment/events/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import EventsTable from "./_events-table/page.mdx"
export const metadata = {
title: `Payment Module Events Reference`,
}
# {metadata.title}
Find in this reference the list of events emitted by the Payment Module.
<EventsTable />
www/apps/resources/app/commerce-modules/pricing/events/_events-table/page.mdx
+189
View File
@@ -0,0 +1,189 @@
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>
<Table.Cell>
`price-set.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a price set is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted price set
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`price-list.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a price list is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted price list
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`price-list-rule.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a price list rule is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted price list rule
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`price-list-rule-value.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a price list rule value is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted price list rule value
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`price-rule.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a price rule is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted price rule
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`price.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a price is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted price
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`price-set-rule-type.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a price set rule type is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted price set rule type
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`rule-type.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a rule type is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted rule type
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/pricing/events/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import EventsTable from "./_events-table/page.mdx"
export const metadata = {
title: `Pricing Module Events Reference`,
}
# {metadata.title}
Find in this reference the list of events emitted by the Pricing Module.
<EventsTable />
www/apps/resources/app/commerce-modules/product/events/_events-table/page.mdx
+299
View File
@@ -0,0 +1,299 @@
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>
`product.created`
</Table.Cell>
<Table.Cell>
Triggered when a product is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the product
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product.updated`
</Table.Cell>
<Table.Cell>
Triggered when a product is updated.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the product
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a product is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted product
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`product-collection.created`
</Table.Cell>
<Table.Cell>
Triggered when a product collection is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the product collection
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product-collection.updated`
</Table.Cell>
<Table.Cell>
Triggered when a product collection is updated.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the product collection
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product-collection.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a product collection is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted product collection
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`product-category.created`
</Table.Cell>
<Table.Cell>
Triggered when a product category is created.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the product category
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product-category.updated`
</Table.Cell>
<Table.Cell>
Triggered when a product category is updated.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the product category
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`product-category.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a product category is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted product category
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`product-option.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a product option is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted product option
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`product-tag.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a product tag is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted product tag
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`product-type.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a product type is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted product type
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row className="bg-medusa-bg-base-hover">
<Table.Cell>
`product-variant.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a product variant is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted product variant
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/product/events/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import EventsTable from "./_events-table/page.mdx"
export const metadata = {
title: `Product Module Events Reference`,
}
# {metadata.title}
Find in this reference the list of events emitted by the Product Module.
<EventsTable />
www/apps/resources/app/commerce-modules/promotion/events/_events-table/page.mdx
+145
View File
@@ -0,0 +1,145 @@
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>
<Table.Cell>
`promotion.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a promotion is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted promotion
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`application-method.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a application method is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted application method
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`campaign.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a campaign is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted campaign
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`campaign-budget.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a campaign budget is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted campaign budget
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`promotion-rule.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a promotion rule is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted promotion rule
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`promotion-rule-value.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a promotion rule value is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted promotion rule value
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/promotion/events/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import EventsTable from "./_events-table/page.mdx"
export const metadata = {
title: `Promotion Module Events Reference`,
}
# {metadata.title}
Find in this reference the list of events emitted by the Promotion Module.
<EventsTable />
www/apps/resources/app/commerce-modules/region/events/_events-table/page.mdx
+57
View File
@@ -0,0 +1,57 @@
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>
<Table.Cell>
`region.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a region is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted region
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`country.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a country is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted country
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/region/events/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import EventsTable from "./_events-table/page.mdx"
export const metadata = {
title: `Region Module Events Reference`,
}
# {metadata.title}
Find in this reference the list of events emitted by the Region Module.
<EventsTable />
www/apps/resources/app/commerce-modules/sales-channel/events/_events-table/page.mdx
+35
View File
@@ -0,0 +1,35 @@
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>
<Table.Cell>
`sales-channel.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a sales channel is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted sales channel
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/sales-channel/events/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import EventsTable from "./_events-table/page.mdx"
export const metadata = {
title: `Sales Channel Module Events Reference`,
}
# {metadata.title}
Find in this reference the list of events emitted by the Sales Channel Module.
<EventsTable />
www/apps/resources/app/commerce-modules/stock-location/events/_events-table/page.mdx
+57
View File
@@ -0,0 +1,57 @@
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>
<Table.Cell>
`stock-location.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a stock location is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted stock location
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`stock-location-address.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a stock location address is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted stock location address
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/stock-location/events/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import EventsTable from "./_events-table/page.mdx"
export const metadata = {
title: `Stock Location Module Events Reference`,
}
# {metadata.title}
Find in this reference the list of events emitted by the Stock Location Module.
<EventsTable />
www/apps/resources/app/commerce-modules/store/events/_events-table/page.mdx
+35
View File
@@ -0,0 +1,35 @@
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>
<Table.Cell>
`store.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a store is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted store
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/store/events/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import EventsTable from "./_events-table/page.mdx"
export const metadata = {
title: `Store Module Events Reference`,
}
# {metadata.title}
Find in this reference the list of events emitted by the Store Module.
<EventsTable />
www/apps/resources/app/commerce-modules/tax/events/_events-table/page.mdx
+101
View File
@@ -0,0 +1,101 @@
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>
<Table.Cell>
`tax-rate.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a tax rate is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted tax rate
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`tax-region.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a tax region is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted tax region
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`tax-rate-rule.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a tax rate rule is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted tax rate rule
id,
}
```
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`tax-provider.deleted`
</Table.Cell>
<Table.Cell>
Triggered when a tax provider is deleted.
</Table.Cell>
<Table.Cell>
```ts noCopy noReport
{
// the ID of the deleted tax provider
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/tax/events/page.mdx
+11
View File
@@ -0,0 +1,11 @@
import EventsTable from "./_events-table/page.mdx"
export const metadata = {
title: `Tax Module Events Reference`,
}
# {metadata.title}
Find in this reference the list of events emitted by the Tax Module.
<EventsTable />
www/apps/resources/app/commerce-modules/user/events/_events-table/page.mdx
+167
View File
@@ -0,0 +1,167 @@
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 noCopy noReport
{
// 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 noCopy noReport
{
// 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 noCopy noReport
{
// 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 noCopy noReport
{
// 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 noCopy noReport
{
// 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 noCopy noReport
{
// 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 noCopy noReport
{
// the ID of the invite
id,
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/commerce-modules/user/events/page.mdx
+11
View File
@@ -0,0 +1,11 @@
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.
<EventsTable />
www/apps/resources/app/events-reference/page.mdx
+55 -3267
View File
File diff suppressed because it is too large Load Diff
www/apps/resources/generated/files-map.mjs
+144
View File
@@ -203,6 +203,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/architectural-modules/workflow-engine/redis/page.mdx",
"pathname": "/architectural-modules/workflow-engine/redis"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/api-key/events/_events-table/page.mdx",
"pathname": "/commerce-modules/api-key/events/_events-table"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/api-key/events/page.mdx",
"pathname": "/commerce-modules/api-key/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/api-key/examples/page.mdx",
"pathname": "/commerce-modules/api-key/examples"
@@ -227,6 +235,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/auth/auth-providers/page.mdx",
"pathname": "/commerce-modules/auth/auth-providers"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/auth/events/_events-table/page.mdx",
"pathname": "/commerce-modules/auth/events/_events-table"
},
{
"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"
@@ -251,6 +267,14 @@ 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/_events-table/page.mdx",
"pathname": "/commerce-modules/cart/events/_events-table"
},
{
"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"
@@ -271,6 +295,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/cart/tax-lines/page.mdx",
"pathname": "/commerce-modules/cart/tax-lines"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/currency/events/_events-table/page.mdx",
"pathname": "/commerce-modules/currency/events/_events-table"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/currency/events/page.mdx",
"pathname": "/commerce-modules/currency/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/currency/examples/page.mdx",
"pathname": "/commerce-modules/currency/examples"
@@ -283,6 +315,14 @@ 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/_events-table/page.mdx",
"pathname": "/commerce-modules/customer/events/_events-table"
},
{
"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"
@@ -299,6 +339,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/fulfillment/concepts/page.mdx",
"pathname": "/commerce-modules/fulfillment/concepts"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/fulfillment/events/_events-table/page.mdx",
"pathname": "/commerce-modules/fulfillment/events/_events-table"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/fulfillment/events/page.mdx",
"pathname": "/commerce-modules/fulfillment/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/fulfillment/fulfillment-provider/page.mdx",
"pathname": "/commerce-modules/fulfillment/fulfillment-provider"
@@ -327,6 +375,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/inventory/concepts/page.mdx",
"pathname": "/commerce-modules/inventory/concepts"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/inventory/events/_events-table/page.mdx",
"pathname": "/commerce-modules/inventory/events/_events-table"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/inventory/events/page.mdx",
"pathname": "/commerce-modules/inventory/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/inventory/examples/page.mdx",
"pathname": "/commerce-modules/inventory/examples"
@@ -347,6 +403,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/order/concepts/page.mdx",
"pathname": "/commerce-modules/order/concepts"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/order/events/_events-table/page.mdx",
"pathname": "/commerce-modules/order/events/_events-table"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/order/events/page.mdx",
"pathname": "/commerce-modules/order/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/order/order-change/page.mdx",
"pathname": "/commerce-modules/order/order-change"
@@ -383,6 +447,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/page.mdx",
"pathname": "/commerce-modules"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/payment/events/_events-table/page.mdx",
"pathname": "/commerce-modules/payment/events/_events-table"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/payment/events/page.mdx",
"pathname": "/commerce-modules/payment/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/payment/examples/page.mdx",
"pathname": "/commerce-modules/payment/examples"
@@ -431,6 +503,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/pricing/concepts/page.mdx",
"pathname": "/commerce-modules/pricing/concepts"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/pricing/events/_events-table/page.mdx",
"pathname": "/commerce-modules/pricing/events/_events-table"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/pricing/events/page.mdx",
"pathname": "/commerce-modules/pricing/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/pricing/examples/page.mdx",
"pathname": "/commerce-modules/pricing/examples"
@@ -447,6 +527,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/pricing/relations-to-other-modules/page.mdx",
"pathname": "/commerce-modules/pricing/relations-to-other-modules"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/product/events/_events-table/page.mdx",
"pathname": "/commerce-modules/product/events/_events-table"
},
{
"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"
@@ -467,6 +555,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/promotion/concepts/page.mdx",
"pathname": "/commerce-modules/promotion/concepts"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/promotion/events/_events-table/page.mdx",
"pathname": "/commerce-modules/promotion/events/_events-table"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/promotion/events/page.mdx",
"pathname": "/commerce-modules/promotion/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/promotion/examples/page.mdx",
"pathname": "/commerce-modules/promotion/examples"
@@ -479,6 +575,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/promotion/relations-to-other-modules/page.mdx",
"pathname": "/commerce-modules/promotion/relations-to-other-modules"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/region/events/_events-table/page.mdx",
"pathname": "/commerce-modules/region/events/_events-table"
},
{
"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"
@@ -491,6 +595,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/region/relations-to-other-modules/page.mdx",
"pathname": "/commerce-modules/region/relations-to-other-modules"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/sales-channel/events/_events-table/page.mdx",
"pathname": "/commerce-modules/sales-channel/events/_events-table"
},
{
"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"
@@ -511,6 +623,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/stock-location/concepts/page.mdx",
"pathname": "/commerce-modules/stock-location/concepts"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/stock-location/events/_events-table/page.mdx",
"pathname": "/commerce-modules/stock-location/events/_events-table"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/stock-location/events/page.mdx",
"pathname": "/commerce-modules/stock-location/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/stock-location/examples/page.mdx",
"pathname": "/commerce-modules/stock-location/examples"
@@ -523,6 +643,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/stock-location/relations-to-other-modules/page.mdx",
"pathname": "/commerce-modules/stock-location/relations-to-other-modules"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/store/events/_events-table/page.mdx",
"pathname": "/commerce-modules/store/events/_events-table"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/store/events/page.mdx",
"pathname": "/commerce-modules/store/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/store/examples/page.mdx",
"pathname": "/commerce-modules/store/examples"
@@ -531,6 +659,14 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/store/page.mdx",
"pathname": "/commerce-modules/store"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/tax/events/_events-table/page.mdx",
"pathname": "/commerce-modules/tax/events/_events-table"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/tax/events/page.mdx",
"pathname": "/commerce-modules/tax/events"
},
{
"filePath": "/www/apps/resources/app/commerce-modules/tax/examples/page.mdx",
"pathname": "/commerce-modules/tax/examples"
@@ -555,6 +691,14 @@ 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/_events-table/page.mdx",
"pathname": "/commerce-modules/user/events/_events-table"
},
{
"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"
www/apps/resources/generated/sidebar.mjs
+126
View File
@@ -162,6 +162,13 @@ export const generatedSidebar = [
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/api-key/events",
"title": "Events Reference",
"children": []
}
]
}
@@ -328,6 +335,13 @@ export const generatedSidebar = [
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/auth/events",
"title": "Events Reference",
"children": []
}
]
}
@@ -830,6 +844,13 @@ export const generatedSidebar = [
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/cart/events",
"title": "Events Reference",
"children": []
}
]
}
@@ -919,6 +940,13 @@ export const generatedSidebar = [
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/currency/events",
"title": "Events Reference",
"children": []
}
]
}
@@ -1197,6 +1225,13 @@ export const generatedSidebar = [
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/customer/events",
"title": "Events Reference",
"children": []
}
]
}
@@ -1825,6 +1860,13 @@ export const generatedSidebar = [
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/fulfillment/events",
"title": "Events Reference",
"children": []
}
]
}
@@ -2173,6 +2215,13 @@ export const generatedSidebar = [
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/inventory/events",
"title": "Events Reference",
"children": []
}
]
}
@@ -2780,6 +2829,13 @@ export const generatedSidebar = [
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/order/events",
"title": "Events Reference",
"children": []
}
]
}
@@ -3121,6 +3177,13 @@ export const generatedSidebar = [
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/payment/events",
"title": "Events Reference",
"children": []
}
]
}
@@ -3588,6 +3651,13 @@ export const generatedSidebar = [
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/pricing/events",
"title": "Events Reference",
"children": []
}
]
}
@@ -4118,6 +4188,13 @@ export const generatedSidebar = [
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/product/events",
"title": "Events Reference",
"children": []
}
]
}
@@ -4431,6 +4508,13 @@ export const generatedSidebar = [
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/promotion/events",
"title": "Events Reference",
"children": []
}
]
}
@@ -4604,6 +4688,13 @@ export const generatedSidebar = [
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/region/events",
"title": "Events Reference",
"children": []
}
]
}
@@ -4756,6 +4847,13 @@ export const generatedSidebar = [
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/sales-channel/events",
"title": "Events Reference",
"children": []
}
]
}
@@ -4915,6 +5013,13 @@ export const generatedSidebar = [
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/stock-location/events",
"title": "Events Reference",
"children": []
}
]
}
@@ -5046,6 +5151,13 @@ export const generatedSidebar = [
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/store/events",
"title": "Events Reference",
"children": []
}
]
}
@@ -5317,6 +5429,13 @@ export const generatedSidebar = [
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/tax/events",
"title": "Events Reference",
"children": []
}
]
}
@@ -5539,6 +5658,13 @@ export const generatedSidebar = [
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"path": "/commerce-modules/user/events",
"title": "Events Reference",
"children": []
}
]
}
www/apps/resources/sidebar.mjs
+72
View File
@@ -65,6 +65,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
{
path: "/commerce-modules/api-key/events",
title: "Events Reference",
},
],
},
],
@@ -133,6 +137,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
{
path: "/commerce-modules/auth/events",
title: "Events Reference",
},
],
},
],
@@ -197,6 +205,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
{
path: "/commerce-modules/cart/events",
title: "Events Reference",
},
],
},
],
@@ -240,6 +252,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
{
path: "/commerce-modules/currency/events",
title: "Events Reference",
},
],
},
],
@@ -296,6 +312,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
{
path: "/commerce-modules/customer/events",
title: "Events Reference",
},
],
},
],
@@ -364,6 +384,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
{
path: "/commerce-modules/fulfillment/events",
title: "Events Reference",
},
],
},
],
@@ -425,6 +449,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
{
path: "/commerce-modules/inventory/events",
title: "Events Reference",
},
],
},
],
@@ -501,6 +529,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
{
path: "/commerce-modules/order/events",
title: "Events Reference",
},
],
},
],
@@ -585,6 +617,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
{
path: "/commerce-modules/payment/events",
title: "Events Reference",
},
],
},
],
@@ -645,6 +681,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
{
path: "/commerce-modules/pricing/events",
title: "Events Reference",
},
],
},
],
@@ -697,6 +737,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
{
path: "/commerce-modules/product/events",
title: "Events Reference",
},
],
},
],
@@ -757,6 +801,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
{
path: "/commerce-modules/promotion/events",
title: "Events Reference",
},
],
},
],
@@ -809,6 +857,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
{
path: "/commerce-modules/region/events",
title: "Events Reference",
},
],
},
],
@@ -866,6 +918,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
{
path: "/commerce-modules/sales-channel/events",
title: "Events Reference",
},
],
},
],
@@ -924,6 +980,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
{
path: "/commerce-modules/stock-location/events",
title: "Events Reference",
},
],
},
],
@@ -967,6 +1027,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
{
path: "/commerce-modules/store/events",
title: "Events Reference",
},
],
},
],
@@ -1035,6 +1099,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
{
path: "/commerce-modules/tax/events",
title: "Events Reference",
},
],
},
],
@@ -1091,6 +1159,10 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
{
path: "/commerce-modules/user/events",
title: "Events Reference",
},
],
},
],
www/packages/docs-ui/src/components/Table/index.tsx
+2 -1
View File
@@ -10,7 +10,8 @@ const Root = ({ className, ...props }: RootProps) => {
className={clsx(
className,
"table-fixed mb-docs_1",
"[&_pre_span]:!max-w-full [&_pre_span]:!break-words [&_pre_span]:!whitespace-break-spaces"
"[&_pre_span]:!max-w-full [&_pre_span]:!break-words [&_pre_span]:!whitespace-break-spaces",
"[&_pre>div]:mt-docs_1"
)}
{...props}
/>
www/packages/eslint-config-docs/content.js
+2 -1
View File
@@ -18,7 +18,8 @@ module.exports = {
plugins: ["prettier", "markdown"],
ignorePatterns: [
"**/references/**",
"**/events-reference/**"
"**/events-reference/**",
"**/_events-table/**"
],
rules: {
"no-undef": "off",