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

chore: fix payloads of events in TSDocs + description of emitEventStep (#14132)

Browse Source
This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-11-26 18:00:21 +02:00
1 parent c3cebdfe80
commit e8990133e5
2 files changed
+102 -82
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

packages/core/core-flows/src/common/steps/emit-event.ts
+20
View File
@@ -30,6 +30,8 @@ type Input = {
* The data payload that the subscriber receives in the `data` property * The data payload that the subscriber receives in the `data` property
* of its first parameter. Use this property to pass data relevant for the * of its first parameter. Use this property to pass data relevant for the
* subscriber, such as the ID of a created record. * subscriber, such as the ID of a created record.
*
* If you pass an array of objects, the event will be emitted once per each object in the array.
*/ */
data: data:
| ((context: StepExecutionContext) => Promise<Record<any, any>>) | ((context: StepExecutionContext) => Promise<Record<any, any>>)
@@ -46,12 +48,30 @@ export const emitEventStepId = "emit-event-step"
* If the workflow fails, it won't emit the event at all. * If the workflow fails, it won't emit the event at all.
* *
* @example * @example
* To emit a single event with a data payload:
*
* ```ts
* emitEventStep({ * emitEventStep({
* eventName: "custom.created", * eventName: "custom.created",
* data: { * data: {
* id: "123" * id: "123"
* } * }
* }) * })
* ```
*
* To emit an event multiple times with different data payloads, pass an array of objects to the `data` property:
*
* ```ts
* emitEventStep({
* eventName: "custom.created",
* data: [
* // emit will be emitted three times, once per each object in the array
* { id: "123" },
* { id: "456" },
* { id: "789" }
* ]
* })
* ```
*/ */
export const emitEventStep = createStep( export const emitEventStep = createStep(
emitEventStepId, emitEventStepId,
packages/core/utils/src/core-flows/events.ts
+82 -82
View File
@@ -75,9 +75,9 @@ export const CustomerWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the customer * id, // The ID of the customer
* }] * }
* ``` * ```
*/ */
CREATED: "customer.created", CREATED: "customer.created",
@@ -86,9 +86,9 @@ export const CustomerWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the customer * id, // The ID of the customer
* }] * }
* ``` * ```
*/ */
UPDATED: "customer.updated", UPDATED: "customer.updated",
@@ -97,9 +97,9 @@ export const CustomerWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the customer * id, // The ID of the customer
* }] * }
* ``` * ```
*/ */
DELETED: "customer.deleted", DELETED: "customer.deleted",
@@ -151,9 +151,9 @@ export const OrderWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the order * id, // The ID of the order
* }] * }
* ``` * ```
*/ */
COMPLETED: "order.completed", COMPLETED: "order.completed",
@@ -162,9 +162,9 @@ export const OrderWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the order * id, // The ID of the order
* }] * }
* ``` * ```
*/ */
ARCHIVED: "order.archived", ARCHIVED: "order.archived",
@@ -320,9 +320,9 @@ export const UserWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the user * id, // The ID of the user
* }] * }
* ``` * ```
*/ */
CREATED: "user.created", CREATED: "user.created",
@@ -331,9 +331,9 @@ export const UserWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the user * id, // The ID of the user
* }] * }
* ``` * ```
*/ */
UPDATED: "user.updated", UPDATED: "user.updated",
@@ -342,9 +342,9 @@ export const UserWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the user * id, // The ID of the user
* }] * }
* ``` * ```
*/ */
DELETED: "user.deleted", DELETED: "user.deleted",
@@ -381,9 +381,9 @@ export const SalesChannelWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the sales channel * id, // The ID of the sales channel
* }] * }
* ``` * ```
*/ */
CREATED: "sales-channel.created", CREATED: "sales-channel.created",
@@ -392,9 +392,9 @@ export const SalesChannelWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the sales channel * id, // The ID of the sales channel
* }] * }
* ``` * ```
*/ */
UPDATED: "sales-channel.updated", UPDATED: "sales-channel.updated",
@@ -403,9 +403,9 @@ export const SalesChannelWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the sales channel * id, // The ID of the sales channel
* }] * }
* ``` * ```
*/ */
DELETED: "sales-channel.deleted", DELETED: "sales-channel.deleted",
@@ -421,9 +421,9 @@ export const ProductCategoryWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the product category * id, // The ID of the product category
* }] * }
* ``` * ```
*/ */
CREATED: "product-category.created", CREATED: "product-category.created",
@@ -432,9 +432,9 @@ export const ProductCategoryWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the product category * id, // The ID of the product category
* }] * }
* ``` * ```
*/ */
UPDATED: "product-category.updated", UPDATED: "product-category.updated",
@@ -443,9 +443,9 @@ export const ProductCategoryWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the product category * id, // The ID of the product category
* }] * }
* ``` * ```
*/ */
DELETED: "product-category.deleted", DELETED: "product-category.deleted",
@@ -461,9 +461,9 @@ export const ProductCollectionWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the product collection * id, // The ID of the product collection
* }] * }
* ``` * ```
*/ */
CREATED: "product-collection.created", CREATED: "product-collection.created",
@@ -472,9 +472,9 @@ export const ProductCollectionWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the product collection * id, // The ID of the product collection
* }] * }
* ``` * ```
*/ */
UPDATED: "product-collection.updated", UPDATED: "product-collection.updated",
@@ -483,9 +483,9 @@ export const ProductCollectionWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the product collection * id, // The ID of the product collection
* }] * }
* ``` * ```
*/ */
DELETED: "product-collection.deleted", DELETED: "product-collection.deleted",
@@ -501,9 +501,9 @@ export const ProductVariantWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the product variant * id, // The ID of the product variant
* }] * }
* ``` * ```
*/ */
UPDATED: "product-variant.updated", UPDATED: "product-variant.updated",
@@ -512,9 +512,9 @@ export const ProductVariantWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the product variant * id, // The ID of the product variant
* }] * }
* ``` * ```
*/ */
CREATED: "product-variant.created", CREATED: "product-variant.created",
@@ -523,9 +523,9 @@ export const ProductVariantWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the product variant * id, // The ID of the product variant
* }] * }
* ``` * ```
*/ */
DELETED: "product-variant.deleted", DELETED: "product-variant.deleted",
@@ -541,9 +541,9 @@ export const ProductWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the product * id, // The ID of the product
* }] * }
* ``` * ```
*/ */
UPDATED: "product.updated", UPDATED: "product.updated",
@@ -552,9 +552,9 @@ export const ProductWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the product * id, // The ID of the product
* }] * }
* ``` * ```
*/ */
CREATED: "product.created", CREATED: "product.created",
@@ -563,9 +563,9 @@ export const ProductWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the product * id, // The ID of the product
* }] * }
* ``` * ```
*/ */
DELETED: "product.deleted", DELETED: "product.deleted",
@@ -581,9 +581,9 @@ export const ProductTypeWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the product type * id, // The ID of the product type
* }] * }
* ``` * ```
*/ */
UPDATED: "product-type.updated", UPDATED: "product-type.updated",
@@ -592,9 +592,9 @@ export const ProductTypeWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the product type * id, // The ID of the product type
* }] * }
* ``` * ```
*/ */
CREATED: "product-type.created", CREATED: "product-type.created",
@@ -603,9 +603,9 @@ export const ProductTypeWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the product type * id, // The ID of the product type
* }] * }
* ``` * ```
*/ */
DELETED: "product-type.deleted", DELETED: "product-type.deleted",
@@ -621,9 +621,9 @@ export const ProductTagWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the product tag * id, // The ID of the product tag
* }] * }
* ``` * ```
*/ */
UPDATED: "product-tag.updated", UPDATED: "product-tag.updated",
@@ -632,9 +632,9 @@ export const ProductTagWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the product tag * id, // The ID of the product tag
* }] * }
* ``` * ```
*/ */
CREATED: "product-tag.created", CREATED: "product-tag.created",
@@ -643,9 +643,9 @@ export const ProductTagWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the product tag * id, // The ID of the product tag
* }] * }
* ``` * ```
*/ */
DELETED: "product-tag.deleted", DELETED: "product-tag.deleted",
@@ -661,9 +661,9 @@ export const ProductOptionWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the product option * id, // The ID of the product option
* }] * }
* ``` * ```
*/ */
UPDATED: "product-option.updated", UPDATED: "product-option.updated",
@@ -672,9 +672,9 @@ export const ProductOptionWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the product option * id, // The ID of the product option
* }] * }
* ``` * ```
*/ */
CREATED: "product-option.created", CREATED: "product-option.created",
@@ -683,9 +683,9 @@ export const ProductOptionWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the product option * id, // The ID of the product option
* }] * }
* ``` * ```
*/ */
DELETED: "product-option.deleted", DELETED: "product-option.deleted",
@@ -713,9 +713,9 @@ export const InviteWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the invite * id, // The ID of the invite
* }] * }
* ``` * ```
*/ */
CREATED: "invite.created", CREATED: "invite.created",
@@ -724,9 +724,9 @@ export const InviteWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the invite * id, // The ID of the invite
* }] * }
* ``` * ```
*/ */
DELETED: "invite.deleted", DELETED: "invite.deleted",
@@ -737,9 +737,9 @@ export const InviteWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the invite * id, // The ID of the invite
* }] * }
* ``` * ```
*/ */
RESENT: "invite.resent", RESENT: "invite.resent",
@@ -755,9 +755,9 @@ export const RegionWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the region * id, // The ID of the region
* }] * }
* ``` * ```
*/ */
UPDATED: "region.updated", UPDATED: "region.updated",
@@ -766,9 +766,9 @@ export const RegionWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the region * id, // The ID of the region
* }] * }
* ``` * ```
*/ */
CREATED: "region.created", CREATED: "region.created",
@@ -777,9 +777,9 @@ export const RegionWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the region * id, // The ID of the region
* }] * }
* ``` * ```
*/ */
DELETED: "region.deleted", DELETED: "region.deleted",
@@ -827,9 +827,9 @@ export const ShippingOptionTypeWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the shipping option type * id, // The ID of the shipping option type
* }] * }
* ``` * ```
*/ */
UPDATED: "shipping-option-type.updated", UPDATED: "shipping-option-type.updated",
@@ -840,9 +840,9 @@ export const ShippingOptionTypeWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the shipping option type * id, // The ID of the shipping option type
* }] * }
* ``` * ```
*/ */
CREATED: "shipping-option-type.created", CREATED: "shipping-option-type.created",
@@ -853,9 +853,9 @@ export const ShippingOptionTypeWorkflowEvents = {
* *
* @eventPayload * @eventPayload
* ```ts * ```ts
* [{ * {
* id, // The ID of the shipping option type * id, // The ID of the shipping option type
* }] * }
* ``` * ```
*/ */
DELETED: "shipping-option-type.deleted", DELETED: "shipping-option-type.deleted",