diff --git a/packages/core/core-flows/src/inventory/steps/adjust-inventory-levels.ts b/packages/core/core-flows/src/inventory/steps/adjust-inventory-levels.ts index 3e5600e1d0..f8c18e047a 100644 --- a/packages/core/core-flows/src/inventory/steps/adjust-inventory-levels.ts +++ b/packages/core/core-flows/src/inventory/steps/adjust-inventory-levels.ts @@ -4,6 +4,9 @@ import { StepResponse, createStep } from "@medusajs/workflows-sdk" import { MathBN, ModuleRegistrationName } from "@medusajs/utils" export const adjustInventoryLevelsStepId = "adjust-inventory-levels-step" +/** + * This step adjusts one or more inventory levels. + */ export const adjustInventoryLevelsStep = createStep( adjustInventoryLevelsStepId, async ( diff --git a/packages/core/core-flows/src/inventory/steps/attach-inventory-items.ts b/packages/core/core-flows/src/inventory/steps/attach-inventory-items.ts index f0b9dd2875..a85056a03a 100644 --- a/packages/core/core-flows/src/inventory/steps/attach-inventory-items.ts +++ b/packages/core/core-flows/src/inventory/steps/attach-inventory-items.ts @@ -5,6 +5,9 @@ import { InventoryItemDTO } from "@medusajs/types" export const attachInventoryItemToVariantsStepId = "attach-inventory-items-to-variants-step" +/** + * This step creates one or more links between variant and inventory item records. + */ export const attachInventoryItemToVariants = createStep( attachInventoryItemToVariantsStepId, async ( diff --git a/packages/core/core-flows/src/inventory/steps/create-inventory-items.ts b/packages/core/core-flows/src/inventory/steps/create-inventory-items.ts index 3e27176507..82ce5c5e86 100644 --- a/packages/core/core-flows/src/inventory/steps/create-inventory-items.ts +++ b/packages/core/core-flows/src/inventory/steps/create-inventory-items.ts @@ -4,6 +4,9 @@ import { IInventoryService, InventoryTypes } from "@medusajs/types" import { ModuleRegistrationName } from "@medusajs/utils" export const createInventoryItemsStepId = "create-inventory-items" +/** + * This step creates one or more inventory items. + */ export const createInventoryItemsStep = createStep( createInventoryItemsStepId, async (data: InventoryTypes.CreateInventoryItemInput[], { container }) => { diff --git a/packages/core/core-flows/src/inventory/steps/create-inventory-levels.ts b/packages/core/core-flows/src/inventory/steps/create-inventory-levels.ts index 1137dbef33..d03cc4a0c7 100644 --- a/packages/core/core-flows/src/inventory/steps/create-inventory-levels.ts +++ b/packages/core/core-flows/src/inventory/steps/create-inventory-levels.ts @@ -4,6 +4,9 @@ import { StepResponse, createStep } from "@medusajs/workflows-sdk" import { ModuleRegistrationName } from "@medusajs/utils" export const createInventoryLevelsStepId = "create-inventory-levels" +/** + * This step creates one or more inventory levels. + */ export const createInventoryLevelsStep = createStep( createInventoryLevelsStepId, async (data: InventoryTypes.CreateInventoryLevelInput[], { container }) => { diff --git a/packages/core/core-flows/src/inventory/steps/delete-inventory-items.ts b/packages/core/core-flows/src/inventory/steps/delete-inventory-items.ts index ce8621345d..b04b66faf1 100644 --- a/packages/core/core-flows/src/inventory/steps/delete-inventory-items.ts +++ b/packages/core/core-flows/src/inventory/steps/delete-inventory-items.ts @@ -3,6 +3,9 @@ import { StepResponse, createStep } from "@medusajs/workflows-sdk" import { ModuleRegistrationName } from "@medusajs/utils" export const deleteInventoryItemStepId = "delete-inventory-item-step" +/** + * This step deletes one or more inventory items. + */ export const deleteInventoryItemStep = createStep( deleteInventoryItemStepId, async (ids: string[], { container }) => { diff --git a/packages/core/core-flows/src/inventory/steps/delete-inventory-levels.ts b/packages/core/core-flows/src/inventory/steps/delete-inventory-levels.ts index bcf8ff0792..90f7232cf0 100644 --- a/packages/core/core-flows/src/inventory/steps/delete-inventory-levels.ts +++ b/packages/core/core-flows/src/inventory/steps/delete-inventory-levels.ts @@ -4,6 +4,9 @@ import { StepResponse, createStep } from "@medusajs/workflows-sdk" import { ModuleRegistrationName } from "@medusajs/utils" export const deleteInventoryLevelsStepId = "delete-inventory-levels-step" +/** + * This step deletes one or more inventory levels. + */ export const deleteInventoryLevelsStep = createStep( deleteInventoryLevelsStepId, async (ids: string[], { container }) => { diff --git a/packages/core/core-flows/src/inventory/steps/delete-levels-by-item-and-location.ts b/packages/core/core-flows/src/inventory/steps/delete-levels-by-item-and-location.ts index 1a36c0e133..1ae842ae12 100644 --- a/packages/core/core-flows/src/inventory/steps/delete-levels-by-item-and-location.ts +++ b/packages/core/core-flows/src/inventory/steps/delete-levels-by-item-and-location.ts @@ -6,6 +6,9 @@ import { MedusaError } from "@medusajs/utils" export const deleteInventoryLevelsFromItemAndLocationsStepId = "delete-inventory-levels-from-item-and-location-step" +/** + * This step removes one or more inventory levels by their associated inventory item and location. + */ export const deleteInventoryLevelsFromItemAndLocationsStep = createStep( deleteInventoryLevelsFromItemAndLocationsStepId, async ( diff --git a/packages/core/core-flows/src/inventory/steps/update-inventory-items.ts b/packages/core/core-flows/src/inventory/steps/update-inventory-items.ts index 59d05728d1..2e448525e8 100644 --- a/packages/core/core-flows/src/inventory/steps/update-inventory-items.ts +++ b/packages/core/core-flows/src/inventory/steps/update-inventory-items.ts @@ -8,6 +8,9 @@ import { StepResponse, createStep } from "@medusajs/workflows-sdk" import { ModuleRegistrationName } from "@medusajs/utils" export const updateInventoryItemsStepId = "update-inventory-items-step" +/** + * This step updates one or more inventory items. + */ export const updateInventoryItemsStep = createStep( updateInventoryItemsStepId, async (input: InventoryTypes.UpdateInventoryItemInput[], { container }) => { diff --git a/packages/core/core-flows/src/inventory/steps/update-inventory-levels.ts b/packages/core/core-flows/src/inventory/steps/update-inventory-levels.ts index a90cb8dc2d..292427f043 100644 --- a/packages/core/core-flows/src/inventory/steps/update-inventory-levels.ts +++ b/packages/core/core-flows/src/inventory/steps/update-inventory-levels.ts @@ -8,6 +8,9 @@ import { StepResponse, createStep } from "@medusajs/workflows-sdk" import { ModuleRegistrationName } from "@medusajs/utils" export const updateInventoryLevelsStepId = "update-inventory-levels-step" +/** + * This step updates one or more inventory levels. + */ export const updateInventoryLevelsStep = createStep( updateInventoryLevelsStepId, async ( diff --git a/packages/core/core-flows/src/inventory/steps/validate-inventory-items.ts b/packages/core/core-flows/src/inventory/steps/validate-inventory-items.ts index 3a434fef0e..67f565504a 100644 --- a/packages/core/core-flows/src/inventory/steps/validate-inventory-items.ts +++ b/packages/core/core-flows/src/inventory/steps/validate-inventory-items.ts @@ -7,6 +7,9 @@ import { import { createStep } from "@medusajs/workflows-sdk" export const validateInventoryItemsId = "validate-inventory-items-step" +/** + * This step ensures that the inventory items with the specified IDs exist. + */ export const validateInventoryItems = createStep( validateInventoryItemsId, async (id: string[], { container }) => { diff --git a/packages/core/core-flows/src/inventory/steps/validate-inventory-locations.ts b/packages/core/core-flows/src/inventory/steps/validate-inventory-locations.ts index 2a920cabd2..5776f3c1b5 100644 --- a/packages/core/core-flows/src/inventory/steps/validate-inventory-locations.ts +++ b/packages/core/core-flows/src/inventory/steps/validate-inventory-locations.ts @@ -9,6 +9,9 @@ import { InventoryTypes } from "@medusajs/types" import { createStep } from "@medusajs/workflows-sdk" export const validateInventoryLocationsStepId = "validate-inventory-levels-step" +/** + * This step ensures that the inventory levels exist for each specified pair of inventory item and location. + */ export const validateInventoryLocationsStep = createStep( validateInventoryLocationsStepId, async (data: InventoryTypes.CreateInventoryLevelInput[], { container }) => { diff --git a/packages/core/core-flows/src/inventory/steps/validate-singular-inventory-items-for-tags.ts b/packages/core/core-flows/src/inventory/steps/validate-singular-inventory-items-for-tags.ts index b6670e782e..442bb33e70 100644 --- a/packages/core/core-flows/src/inventory/steps/validate-singular-inventory-items-for-tags.ts +++ b/packages/core/core-flows/src/inventory/steps/validate-singular-inventory-items-for-tags.ts @@ -7,6 +7,9 @@ import { createStep, StepResponse } from "@medusajs/workflows-sdk" export const validateInventoryItemsForCreateStepId = "validate-inventory-items-for-create-step" +/** + * This step checks whether a variant already has an inventory item. + */ export const validateInventoryItemsForCreate = createStep( validateInventoryItemsForCreateStepId, async ( diff --git a/packages/core/core-flows/src/invite/steps/create-invites.ts b/packages/core/core-flows/src/invite/steps/create-invites.ts index b19ffd6a67..0e5f027f6e 100644 --- a/packages/core/core-flows/src/invite/steps/create-invites.ts +++ b/packages/core/core-flows/src/invite/steps/create-invites.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const createInviteStepId = "create-invite-step" +/** + * This step creates one or more invites. + */ export const createInviteStep = createStep( createInviteStepId, async (input: CreateInviteDTO[], { container }) => { diff --git a/packages/core/core-flows/src/invite/steps/delete-invites.ts b/packages/core/core-flows/src/invite/steps/delete-invites.ts index dbbeb50435..3454326907 100644 --- a/packages/core/core-flows/src/invite/steps/delete-invites.ts +++ b/packages/core/core-flows/src/invite/steps/delete-invites.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const deleteInvitesStepId = "delete-invites-step" +/** + * This step deletes one or more invites. + */ export const deleteInvitesStep = createStep( deleteInvitesStepId, async (input: string[], { container }) => { diff --git a/packages/core/core-flows/src/invite/steps/refresh-invite-tokens.ts b/packages/core/core-flows/src/invite/steps/refresh-invite-tokens.ts index 26278d8f81..f36eac6c42 100644 --- a/packages/core/core-flows/src/invite/steps/refresh-invite-tokens.ts +++ b/packages/core/core-flows/src/invite/steps/refresh-invite-tokens.ts @@ -4,6 +4,9 @@ import { StepResponse, createStep } from "@medusajs/workflows-sdk" import { ModuleRegistrationName } from "@medusajs/utils" export const refreshInviteTokensStepId = "refresh-invite-tokens-step" +/** + * This step refreshes the tokens of one or more invites. + */ export const refreshInviteTokensStep = createStep( refreshInviteTokensStepId, async (input: string[], { container }) => { diff --git a/packages/core/core-flows/src/invite/steps/validate-token.ts b/packages/core/core-flows/src/invite/steps/validate-token.ts index 11aedea937..c4b91b8b6b 100644 --- a/packages/core/core-flows/src/invite/steps/validate-token.ts +++ b/packages/core/core-flows/src/invite/steps/validate-token.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const validateTokenStepId = "validate-invite-token-step" +/** + * This step validates a specified token and returns its associated invite. + */ export const validateTokenStep = createStep( validateTokenStepId, async (input: string, { container }) => { diff --git a/packages/core/core-flows/src/invite/workflows/accept-invite.ts b/packages/core/core-flows/src/invite/workflows/accept-invite.ts index bca8d9d07f..2a1e49657c 100644 --- a/packages/core/core-flows/src/invite/workflows/accept-invite.ts +++ b/packages/core/core-flows/src/invite/workflows/accept-invite.ts @@ -11,6 +11,9 @@ import { validateTokenStep } from "../steps/validate-token" import { setAuthAppMetadataStep } from "../../auth" export const acceptInviteWorkflowId = "accept-invite-workflow" +/** + * This workflow accepts an invite and creates a user. + */ export const acceptInviteWorkflow = createWorkflow( acceptInviteWorkflowId, ( diff --git a/packages/core/core-flows/src/invite/workflows/create-invites.ts b/packages/core/core-flows/src/invite/workflows/create-invites.ts index 02617da5f1..f7460e55a8 100644 --- a/packages/core/core-flows/src/invite/workflows/create-invites.ts +++ b/packages/core/core-flows/src/invite/workflows/create-invites.ts @@ -7,6 +7,9 @@ import { createInviteStep } from "../steps" import { InviteDTO, InviteWorkflow } from "@medusajs/types" export const createInvitesWorkflowId = "create-invite-step" +/** + * This workflow creates one or more invites. + */ export const createInvitesWorkflow = createWorkflow( createInvitesWorkflowId, ( diff --git a/packages/core/core-flows/src/invite/workflows/delete-invites.ts b/packages/core/core-flows/src/invite/workflows/delete-invites.ts index 0b82f68f93..f6f66b0822 100644 --- a/packages/core/core-flows/src/invite/workflows/delete-invites.ts +++ b/packages/core/core-flows/src/invite/workflows/delete-invites.ts @@ -3,6 +3,9 @@ import { deleteInvitesStep } from "../steps" import { InviteWorkflow, UserWorkflow } from "@medusajs/types" export const deleteInvitesWorkflowId = "delete-invites-workflow" +/** + * This workflow deletes one or more invites. + */ export const deleteInvitesWorkflow = createWorkflow( deleteInvitesWorkflowId, ( diff --git a/packages/core/core-flows/src/invite/workflows/refresh-invite-tokens.ts b/packages/core/core-flows/src/invite/workflows/refresh-invite-tokens.ts index ff4369c681..165acd9eab 100644 --- a/packages/core/core-flows/src/invite/workflows/refresh-invite-tokens.ts +++ b/packages/core/core-flows/src/invite/workflows/refresh-invite-tokens.ts @@ -8,6 +8,9 @@ import { import { refreshInviteTokensStep } from "../steps/refresh-invite-tokens" export const refreshInviteTokensWorkflowId = "refresh-invite-tokens-workflow" +/** + * This workflow refreshes the token of one or more invites. + */ export const refreshInviteTokensWorkflow = createWorkflow( refreshInviteTokensWorkflowId, ( diff --git a/packages/core/core-flows/src/notification/steps/notify-on-failure.ts b/packages/core/core-flows/src/notification/steps/notify-on-failure.ts index d1f0e6547a..c10790d711 100644 --- a/packages/core/core-flows/src/notification/steps/notify-on-failure.ts +++ b/packages/core/core-flows/src/notification/steps/notify-on-failure.ts @@ -2,7 +2,7 @@ import { INotificationModuleService } from "@medusajs/types" import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" -type NotifyOnFailureStepInput = { +export type NotifyOnFailureStepInput = { to: string channel: string template: string @@ -16,6 +16,11 @@ type NotifyOnFailureStepInput = { }[] export const notifyOnFailureStepId = "notify-on-failure" +/** + * This step sends one or more notification when a workflow fails. This + * step can be used in a workflow for its compensation function. When the workflow fails, + * its compensation function is triggered to send the notification. + */ export const notifyOnFailureStep = createStep( notifyOnFailureStepId, async (data: NotifyOnFailureStepInput) => { diff --git a/packages/core/core-flows/src/notification/steps/send-notifications.ts b/packages/core/core-flows/src/notification/steps/send-notifications.ts index df36598bc0..85ac43e77f 100644 --- a/packages/core/core-flows/src/notification/steps/send-notifications.ts +++ b/packages/core/core-flows/src/notification/steps/send-notifications.ts @@ -2,7 +2,7 @@ import { INotificationModuleService } from "@medusajs/types" import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" -type SendNotificationsStepInput = { +export type SendNotificationsStepInput = { to: string channel: string template: string @@ -16,6 +16,9 @@ type SendNotificationsStepInput = { }[] export const sendNotificationsStepId = "send-notifications" +/** + * This step sends one or more notifications. + */ export const sendNotificationsStep = createStep( sendNotificationsStepId, async (data: SendNotificationsStepInput, { container }) => {