From c444c15f4f839b80962f7c6902b2d0fe31ccda48 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Wed, 27 Nov 2024 17:18:27 +0200 Subject: [PATCH] docs: add note about actor_type in reset password event in v2.0.7 --- .../app/commerce-modules/auth/reset-password/page.mdx | 6 ++++++ www/apps/resources/app/events-reference/page.mdx | 3 ++- www/apps/resources/generated/edit-dates.mjs | 5 +++-- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/www/apps/resources/app/commerce-modules/auth/reset-password/page.mdx b/www/apps/resources/app/commerce-modules/auth/reset-password/page.mdx index 432d0036c023d..632e3fb4a6dda 100644 --- a/www/apps/resources/app/commerce-modules/auth/reset-password/page.mdx +++ b/www/apps/resources/app/commerce-modules/auth/reset-password/page.mdx @@ -83,6 +83,12 @@ You subscribe to the `auth.password_reset` event. The event has a data payload o - `token`: The token to reset the user's password. - `actor_type`: The user's actor type. For example, if the user is a customer, the `actor_type` is `customer`. If it's an admin user, the `actor_type` is `user`. + + +This event's payload previously had an `actorType` field. It was renamed to `actor_type` after [Medusa v2.0.7](https://github.com/medusajs/medusa/releases/tag/v2.0.7). + + + In the subscriber, you: - Decide the frontend URL based on whether the user is a customer or admin user by checking the value of `actor_type`. diff --git a/www/apps/resources/app/events-reference/page.mdx b/www/apps/resources/app/events-reference/page.mdx index 5fa7fbd75c7c2..9ac0affa323a9 100644 --- a/www/apps/resources/app/events-reference/page.mdx +++ b/www/apps/resources/app/events-reference/page.mdx @@ -34,8 +34,9 @@ This documentation page includes the list of all events emitted by [Medusa's wor ```ts blockStyle="inline" { - entityId, // The ID of the user + entity_id, // The user's identifier, such as their email token, // The reset token + actor_type // `user`, `customer`, or custom type } ``` diff --git a/www/apps/resources/generated/edit-dates.mjs b/www/apps/resources/generated/edit-dates.mjs index b56f4b98fec8e..7ba35beb94454 100644 --- a/www/apps/resources/generated/edit-dates.mjs +++ b/www/apps/resources/generated/edit-dates.mjs @@ -2201,7 +2201,7 @@ export const generatedEditDates = { "app/admin-components/layouts/single-column/page.mdx": "2024-10-07T11:16:06.435Z", "app/admin-components/layouts/two-column/page.mdx": "2024-10-07T11:16:10.092Z", "app/admin-components/components/forms/page.mdx": "2024-10-09T12:48:04.229Z", - "app/commerce-modules/auth/reset-password/page.mdx": "2024-09-25T09:36:26.592Z", + "app/commerce-modules/auth/reset-password/page.mdx": "2024-11-27T13:33:55.940Z", "app/storefront-development/customers/reset-password/page.mdx": "2024-09-25T10:21:46.647Z", "app/commerce-modules/api-key/links-to-other-modules/page.mdx": "2024-10-08T08:05:36.596Z", "app/commerce-modules/cart/extend/page.mdx": "2024-10-08T11:22:22.523Z", @@ -3392,5 +3392,6 @@ export const generatedEditDates = { "references/types/types.InventoryTypes/page.mdx": "2024-11-25T17:49:27.667Z", "references/types/types.StockLocationTypes/page.mdx": "2024-11-25T17:49:28.127Z", "references/user/interfaces/user.IMessageAggregator/page.mdx": "2024-11-25T17:49:59.536Z", - "references/utils/utils.PromotionUtils/page.mdx": "2024-11-25T17:49:28.611Z" + "references/utils/utils.PromotionUtils/page.mdx": "2024-11-25T17:49:28.611Z", + "app/events-reference/page.mdx": "2024-11-27T13:31:07.385Z" } \ No newline at end of file