docs: split events reference across modules (#10711)

* docs: split events reference across modules * add lint exceptions
2024-12-24 09:54:51 +02:00
parent a4335f2a47
commit fd1afa8bc9
38 changed files with 1647 additions and 1301 deletions
@@ -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>
@@ -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 />