docs: rename Architectural Modules to Infrastructure Modules (#12212)

* docs: rename Architectural Modules to Infrastructure Modules * generate again
2025-04-17 13:20:43 +03:00
parent 8618e6ee38
commit eb73bdb478
149 changed files with 12165 additions and 12145 deletions
@@ -0,0 +1,98 @@
+import { CardList } from "docs-ui"
+
+export const metadata = {
+  title: `Event Module`,
+}
+
+# {metadata.title}
+
+In this document, you'll learn what an Event Module is and how to use it in your Medusa application.
+
+## What is an Event Module?
+
+An Event Module implements the underlying publish/subscribe system that handles queueing events, emitting them, and executing their subscribers. 
+
+This makes the event architecture customizable, as you can either choose one of Medusa’s event modules or create your own.
+
+<Note>
+
+Learn more about Medusa's event systems in the [Events and Subscribers documentation](!docs!/learn/fundamentals/events-and-subscribers).
+
+</Note>
+
+### Default Event Module
+
+By default, Medusa uses the [Local Event Module](./local/page.mdx). This module uses Node’s EventEmitter to implement the publish/subscribe system. While this is suitable for development, it's recommended to use other Event Modules, such as the [Redis Event Module](./redis/page.mdx), for production. You can also [Create an Event Module](./create/page.mdx).
+
+---
+
+## How to Use the Event Module?
+
+You can use the registered Event Module as part of the [workflows](!docs!/learn/fundamentals/workflows) you build for your custom features. A workflow is a special function composed of a series of steps that guarantees data consistency and reliable roll-back mechanism.
+
+Medusa provides the helper step [emitEventStep](/references/helper-steps/emitEventStep) that you can use in your workflow. You can also resolve the Event Module's service in a step of your workflow and use its methods to emit events.
+
+For example:
+
+```ts
+import { Modules } from "@medusajs/framework/utils"
+import { 
+  createStep,
+  createWorkflow,
+} from "@medusajs/framework/workflows-sdk"
+
+const step1 = createStep(
+  "step-1",
+  async ({}, { container }) => {
+    const eventModuleService = container.resolve(
+      Modules.EVENT
+    )
+
+    await eventModuleService.emit({
+      name: "custom.event",
+      data: {
+        id: "123",
+        // other data payload
+      },
+    })
+  } 
+)
+
+export const workflow = createWorkflow(
+  "workflow-1",
+  () => {
+    step1()
+  }
+)
+```
+
+In the example above, you create a workflow that has a step. In the step, you resolve the service of the Event Module from the [Medusa container](!docs!/learn/fundamentals/medusa-container).
+
+Then, you use the `emit` method of the Event Module to emit an event with the name `"custom.event"` and the data payload `{ id: "123" }`.
+
+---
+
+## List of Event Modules
+
+Medusa provides the following Event Modules. You can use one of them, or [Create an Event Module](./create/page.mdx).
+
+<CardList
+  items={[
+    {
+      title: "Local",
+      href: "/infrastructure-modules/event/local",
+      badge: {
+        variant: "neutral",
+        children: "For Development"
+      }
+    },
+    {
+      title: "Redis",
+      href: "/infrastructure-modules/event/redis",
+      badge: {
+        variant: "green",
+        children: "For Production"
+      }
+    }
+  ]}
+/>