diff --git a/packages/core/core-flows/src/order/steps/claim/cancel-claim.ts b/packages/core/core-flows/src/order/steps/claim/cancel-claim.ts index 828b572bd1..174ae29faf 100644 --- a/packages/core/core-flows/src/order/steps/claim/cancel-claim.ts +++ b/packages/core/core-flows/src/order/steps/claim/cancel-claim.ts @@ -2,12 +2,13 @@ import { CancelOrderClaimDTO, IOrderModuleService } from "@medusajs/types" import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" -type CancelOrderClaimStepInput = CancelOrderClaimDTO - export const cancelOrderClaimStepId = "cancel-order-claim" +/** + * This step cancels a claim. + */ export const cancelOrderClaimStep = createStep( cancelOrderClaimStepId, - async (data: CancelOrderClaimStepInput, { container }) => { + async (data: CancelOrderClaimDTO, { container }) => { const service = container.resolve( ModuleRegistrationName.ORDER ) diff --git a/packages/core/core-flows/src/order/steps/claim/create-claim-items-from-actions.ts b/packages/core/core-flows/src/order/steps/claim/create-claim-items-from-actions.ts index ec1f8c6993..e2280f7352 100644 --- a/packages/core/core-flows/src/order/steps/claim/create-claim-items-from-actions.ts +++ b/packages/core/core-flows/src/order/steps/claim/create-claim-items-from-actions.ts @@ -2,11 +2,14 @@ import { IOrderModuleService, OrderChangeActionDTO } from "@medusajs/types" import { ChangeActionType, ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" -type CreateOrderClaimItemsFromActionsInput = { +export type CreateOrderClaimItemsFromActionsInput = { changes: OrderChangeActionDTO[] claimId: string } +/** + * This step creates claim items from a change action. + */ export const createOrderClaimItemsFromActionsStep = createStep( "create-claim-items-from-change-actions", async (input: CreateOrderClaimItemsFromActionsInput, { container }) => { diff --git a/packages/core/core-flows/src/order/steps/claim/create-claims.ts b/packages/core/core-flows/src/order/steps/claim/create-claims.ts index c7458a6cde..f632feabc8 100644 --- a/packages/core/core-flows/src/order/steps/claim/create-claims.ts +++ b/packages/core/core-flows/src/order/steps/claim/create-claims.ts @@ -2,12 +2,13 @@ import { CreateOrderClaimDTO, IOrderModuleService } from "@medusajs/types" import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" -type CreateOrderClaimsStepInput = CreateOrderClaimDTO[] - export const createOrderClaimsStepId = "create-order-claims" +/** + * This step creates one or more order claims. + */ export const createOrderClaimsStep = createStep( createOrderClaimsStepId, - async (data: CreateOrderClaimsStepInput, { container }) => { + async (data: CreateOrderClaimDTO[], { container }) => { const service = container.resolve( ModuleRegistrationName.ORDER ) diff --git a/packages/core/core-flows/src/order/steps/claim/delete-claims.ts b/packages/core/core-flows/src/order/steps/claim/delete-claims.ts index c6d4cd4154..67ad988bcc 100644 --- a/packages/core/core-flows/src/order/steps/claim/delete-claims.ts +++ b/packages/core/core-flows/src/order/steps/claim/delete-claims.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { createStep, StepResponse } from "@medusajs/workflows-sdk" export const deleteClaimsStepId = "delete-claims" +/** + * This step deletes one or more order claims. + */ export const deleteClaimsStep = createStep( deleteClaimsStepId, async (data: { ids: string[] }, { container }) => { diff --git a/packages/core/core-flows/src/order/steps/claim/update-order-claims.ts b/packages/core/core-flows/src/order/steps/claim/update-order-claims.ts index 23ac9b8277..eccd3a41f4 100644 --- a/packages/core/core-flows/src/order/steps/claim/update-order-claims.ts +++ b/packages/core/core-flows/src/order/steps/claim/update-order-claims.ts @@ -6,6 +6,9 @@ import { import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const updateOrderClaimsStepId = "update-order-claim" +/** + * This step updates one or more claims. + */ export const updateOrderClaimsStep = createStep( updateOrderClaimsStepId, async (data: UpdateOrderClaimDTO[], { container }) => { diff --git a/packages/core/core-flows/src/order/steps/exchange/cancel-exchange.ts b/packages/core/core-flows/src/order/steps/exchange/cancel-exchange.ts index 473fd7ae3f..b4e77e863e 100644 --- a/packages/core/core-flows/src/order/steps/exchange/cancel-exchange.ts +++ b/packages/core/core-flows/src/order/steps/exchange/cancel-exchange.ts @@ -2,12 +2,13 @@ import { CancelOrderExchangeDTO, IOrderModuleService } from "@medusajs/types" import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" -type CancelOrderExchangeStepInput = CancelOrderExchangeDTO - export const cancelOrderExchangeStepId = "cancel-order-swap" +/** + * This step cancels an exchange. + */ export const cancelOrderExchangeStep = createStep( cancelOrderExchangeStepId, - async (data: CancelOrderExchangeStepInput, { container }) => { + async (data: CancelOrderExchangeDTO, { container }) => { const service = container.resolve( ModuleRegistrationName.ORDER ) diff --git a/packages/core/core-flows/src/order/steps/exchange/create-exchange-items-from-actions.ts b/packages/core/core-flows/src/order/steps/exchange/create-exchange-items-from-actions.ts index e451833c23..834f1d6882 100644 --- a/packages/core/core-flows/src/order/steps/exchange/create-exchange-items-from-actions.ts +++ b/packages/core/core-flows/src/order/steps/exchange/create-exchange-items-from-actions.ts @@ -6,11 +6,14 @@ import { import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" -type CreateOrderExchangeItemsFromActionsInput = { +export type CreateOrderExchangeItemsFromActionsInput = { changes: OrderChangeActionDTO[] exchangeId: string } +/** + * This step creates exchange items from change actions. + */ export const createOrderExchangeItemsFromActionsStep = createStep( "create-exchange-items-from-change-actions", async (input: CreateOrderExchangeItemsFromActionsInput, { container }) => { diff --git a/packages/core/core-flows/src/order/steps/exchange/create-exchange.ts b/packages/core/core-flows/src/order/steps/exchange/create-exchange.ts index eac3c8ae37..4acbb3aa9b 100644 --- a/packages/core/core-flows/src/order/steps/exchange/create-exchange.ts +++ b/packages/core/core-flows/src/order/steps/exchange/create-exchange.ts @@ -2,12 +2,13 @@ import { CreateOrderExchangeDTO, IOrderModuleService } from "@medusajs/types" import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" -type CreateOrderExchangesStepInput = CreateOrderExchangeDTO[] - export const createOrderExchangesStepId = "create-order-exchanges" +/** + * This step creates one or more order exchanges. + */ export const createOrderExchangesStep = createStep( createOrderExchangesStepId, - async (data: CreateOrderExchangesStepInput, { container }) => { + async (data: CreateOrderExchangeDTO[], { container }) => { const service = container.resolve( ModuleRegistrationName.ORDER ) diff --git a/packages/core/core-flows/src/order/steps/exchange/delete-exchanges.ts b/packages/core/core-flows/src/order/steps/exchange/delete-exchanges.ts index 353dd26a89..f1dd6dd34d 100644 --- a/packages/core/core-flows/src/order/steps/exchange/delete-exchanges.ts +++ b/packages/core/core-flows/src/order/steps/exchange/delete-exchanges.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { createStep, StepResponse } from "@medusajs/workflows-sdk" export const deleteExchangesStepId = "delete-exchanges" +/** + * This step deletes one or more exchanges. + */ export const deleteExchangesStep = createStep( deleteExchangesStepId, async (data: { ids: string[] }, { container }) => { diff --git a/packages/core/core-flows/src/order/steps/exchange/update-order-exchanges.ts b/packages/core/core-flows/src/order/steps/exchange/update-order-exchanges.ts index b949b5d860..a6ade05348 100644 --- a/packages/core/core-flows/src/order/steps/exchange/update-order-exchanges.ts +++ b/packages/core/core-flows/src/order/steps/exchange/update-order-exchanges.ts @@ -6,6 +6,9 @@ import { import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const updateOrderExchangesStepId = "update-order-exchange" +/** + * This step updates one or more exchanges. + */ export const updateOrderExchangesStep = createStep( updateOrderExchangesStepId, async (data: UpdateOrderExchangeDTO[], { container }) => { diff --git a/packages/core/core-flows/src/order/steps/return/cancel-return.ts b/packages/core/core-flows/src/order/steps/return/cancel-return.ts index d29a1839bd..62b1388ca7 100644 --- a/packages/core/core-flows/src/order/steps/return/cancel-return.ts +++ b/packages/core/core-flows/src/order/steps/return/cancel-return.ts @@ -2,12 +2,13 @@ import { CancelOrderReturnDTO, IOrderModuleService } from "@medusajs/types" import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" -type CancelOrderReturnStepInput = CancelOrderReturnDTO - export const cancelOrderReturnStepId = "cancel-order-return" +/** + * This step cancels a return. + */ export const cancelOrderReturnStep = createStep( cancelOrderReturnStepId, - async (data: CancelOrderReturnStepInput, { container }) => { + async (data: CancelOrderReturnDTO, { container }) => { const service = container.resolve( ModuleRegistrationName.ORDER ) diff --git a/packages/core/core-flows/src/order/steps/return/create-complete-return.ts b/packages/core/core-flows/src/order/steps/return/create-complete-return.ts index 4ca9f58821..54b9b48433 100644 --- a/packages/core/core-flows/src/order/steps/return/create-complete-return.ts +++ b/packages/core/core-flows/src/order/steps/return/create-complete-return.ts @@ -2,12 +2,13 @@ import { CreateOrderReturnDTO, IOrderModuleService } from "@medusajs/types" import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" -type CreateCompleteReturnStepInput = CreateOrderReturnDTO - export const createCompleteReturnStepId = "create-complete-return" +/** + * This step creates a return. + */ export const createCompleteReturnStep = createStep( createCompleteReturnStepId, - async (data: CreateCompleteReturnStepInput, { container }) => { + async (data: CreateOrderReturnDTO, { container }) => { const service = container.resolve( ModuleRegistrationName.ORDER ) diff --git a/packages/core/core-flows/src/order/steps/return/create-return-items-from-actions.ts b/packages/core/core-flows/src/order/steps/return/create-return-items-from-actions.ts index 6a8fc0e9fa..e7c173191e 100644 --- a/packages/core/core-flows/src/order/steps/return/create-return-items-from-actions.ts +++ b/packages/core/core-flows/src/order/steps/return/create-return-items-from-actions.ts @@ -6,11 +6,14 @@ import { import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" -type CreateReturnItemsFromActionsInput = { +export type CreateReturnItemsFromActionsInput = { changes: OrderChangeActionDTO[] returnId: string } +/** + * This step creates return items from change actions. + */ export const createReturnItemsFromActionsStep = createStep( "create-return-items-from-change-actions", async (input: CreateReturnItemsFromActionsInput, { container }) => { diff --git a/packages/core/core-flows/src/order/steps/return/create-returns.ts b/packages/core/core-flows/src/order/steps/return/create-returns.ts index 4d54c0c14a..b7e6a6c8f7 100644 --- a/packages/core/core-flows/src/order/steps/return/create-returns.ts +++ b/packages/core/core-flows/src/order/steps/return/create-returns.ts @@ -2,12 +2,13 @@ import { CreateOrderReturnDTO, IOrderModuleService } from "@medusajs/types" import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" -type CreateReturnsStepInput = CreateOrderReturnDTO[] - export const createReturnsStepId = "create-returns" +/** + * This step creates returns. + */ export const createReturnsStep = createStep( createReturnsStepId, - async (data: CreateReturnsStepInput, { container }) => { + async (data: CreateOrderReturnDTO[], { container }) => { const service = container.resolve( ModuleRegistrationName.ORDER ) diff --git a/packages/core/core-flows/src/order/steps/return/delete-returns.ts b/packages/core/core-flows/src/order/steps/return/delete-returns.ts index 383b06c0d0..39e1fce821 100644 --- a/packages/core/core-flows/src/order/steps/return/delete-returns.ts +++ b/packages/core/core-flows/src/order/steps/return/delete-returns.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { createStep, StepResponse } from "@medusajs/workflows-sdk" export const deleteReturnsStepId = "delete-return" +/** + * This step deletes one or more returns. + */ export const deleteReturnsStep = createStep( deleteReturnsStepId, async (data: { ids: string[] }, { container }) => { diff --git a/packages/core/core-flows/src/order/steps/return/receive-return.ts b/packages/core/core-flows/src/order/steps/return/receive-return.ts index 89f1351389..ff3040aa9f 100644 --- a/packages/core/core-flows/src/order/steps/return/receive-return.ts +++ b/packages/core/core-flows/src/order/steps/return/receive-return.ts @@ -2,12 +2,13 @@ import { IOrderModuleService, ReceiveOrderReturnDTO } from "@medusajs/types" import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" -type ReceiveReturnStepInput = ReceiveOrderReturnDTO - export const receiveReturnStepId = "receive-return" +/** + * This step marks a return as received. + */ export const receiveReturnStep = createStep( receiveReturnStepId, - async (data: ReceiveReturnStepInput, { container }) => { + async (data: ReceiveOrderReturnDTO, { container }) => { const service = container.resolve( ModuleRegistrationName.ORDER ) diff --git a/packages/core/core-flows/src/order/steps/return/update-return-items.ts b/packages/core/core-flows/src/order/steps/return/update-return-items.ts index 0f1ccf1927..ea50bae935 100644 --- a/packages/core/core-flows/src/order/steps/return/update-return-items.ts +++ b/packages/core/core-flows/src/order/steps/return/update-return-items.ts @@ -4,12 +4,15 @@ import { } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" -interface UpdateReturnItemBySelector { +export interface UpdateReturnItemBySelector { id: string [key: string]: any } export const updateReturnItemsStepId = "update-return-items" +/** + * This step updates return items. + */ export const updateReturnItemsStep = createStep( updateReturnItemsStepId, async (data: UpdateReturnItemBySelector[], { container }) => { diff --git a/packages/core/core-flows/src/order/steps/return/update-returns.ts b/packages/core/core-flows/src/order/steps/return/update-returns.ts index 05b4527275..efe896d221 100644 --- a/packages/core/core-flows/src/order/steps/return/update-returns.ts +++ b/packages/core/core-flows/src/order/steps/return/update-returns.ts @@ -6,6 +6,9 @@ import { import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const updateReturnsStepId = "update-returns" +/** + * This step updates one or more returns. + */ export const updateReturnsStep = createStep( updateReturnsStepId, async (data: UpdateReturnDTO[], { container }) => { diff --git a/packages/core/core-flows/src/order/workflows/decline-order-change.ts b/packages/core/core-flows/src/order/workflows/decline-order-change.ts index 6f244581a3..08e0fe12cc 100644 --- a/packages/core/core-flows/src/order/workflows/decline-order-change.ts +++ b/packages/core/core-flows/src/order/workflows/decline-order-change.ts @@ -3,6 +3,9 @@ import { WorkflowData, createWorkflow } from "@medusajs/workflows-sdk" import { declineOrderChangeStep } from "../steps" export const declineOrderChangeWorkflowId = "decline-order-change" +/** + * This workflow declines an order change. + */ export const declineOrderChangeWorkflow = createWorkflow( declineOrderChangeWorkflowId, (input: WorkflowData): WorkflowData => { diff --git a/packages/core/core-flows/src/order/workflows/delete-order-change-actions.ts b/packages/core/core-flows/src/order/workflows/delete-order-change-actions.ts index d278042f98..4ab8761b95 100644 --- a/packages/core/core-flows/src/order/workflows/delete-order-change-actions.ts +++ b/packages/core/core-flows/src/order/workflows/delete-order-change-actions.ts @@ -2,6 +2,9 @@ import { WorkflowData, createWorkflow } from "@medusajs/workflows-sdk" import { deleteOrderChangeActionsStep } from "../steps" export const deleteOrderChangeActionsWorkflowId = "delete-order-change-actions" +/** + * This workflow deletes one or more order change actions. + */ export const deleteOrderChangeActionsWorkflow = createWorkflow( deleteOrderChangeActionsWorkflowId, (input: WorkflowData<{ ids: string[] }>): WorkflowData => { diff --git a/packages/core/core-flows/src/order/workflows/delete-order-change.ts b/packages/core/core-flows/src/order/workflows/delete-order-change.ts index bbfec5bb8a..fa9f32a0a4 100644 --- a/packages/core/core-flows/src/order/workflows/delete-order-change.ts +++ b/packages/core/core-flows/src/order/workflows/delete-order-change.ts @@ -2,6 +2,9 @@ import { WorkflowData, createWorkflow } from "@medusajs/workflows-sdk" import { deleteOrderChangesStep } from "../steps" export const deleteOrderChangeWorkflowId = "delete-order-change" +/** + * This workflow deletes one or more order changes. + */ export const deleteOrderChangeWorkflow = createWorkflow( deleteOrderChangeWorkflowId, (input: WorkflowData<{ ids: string[] }>): WorkflowData => { diff --git a/packages/core/core-flows/src/order/workflows/get-order-detail.ts b/packages/core/core-flows/src/order/workflows/get-order-detail.ts index 794dfca470..099ddfe5c6 100644 --- a/packages/core/core-flows/src/order/workflows/get-order-detail.ts +++ b/packages/core/core-flows/src/order/workflows/get-order-detail.ts @@ -13,6 +13,9 @@ import { } from "../utils/aggregate-status" export const getOrderDetailWorkflowId = "get-order-detail" +/** + * This workflow retrieves an order's details. + */ export const getOrderDetailWorkflow = createWorkflow( getOrderDetailWorkflowId, ( diff --git a/packages/core/core-flows/src/order/workflows/get-orders-list.ts b/packages/core/core-flows/src/order/workflows/get-orders-list.ts index 9a8c6207f8..9d91aa3f50 100644 --- a/packages/core/core-flows/src/order/workflows/get-orders-list.ts +++ b/packages/core/core-flows/src/order/workflows/get-orders-list.ts @@ -12,7 +12,7 @@ import { getLastPaymentStatus, } from "../utils/aggregate-status" -type OrderOutput = +export type GetOrdersListWorkflowOutput = | OrderDTO[] | { rows: OrderDTO[] @@ -20,6 +20,9 @@ type OrderOutput = } export const getOrdersListWorkflowId = "get-orders-list" +/** + * This workflow retrieves a list of orders. + */ export const getOrdersListWorkflow = createWorkflow( getOrdersListWorkflowId, ( @@ -27,7 +30,7 @@ export const getOrdersListWorkflow = createWorkflow( fields: string[] variables?: Record }> - ): WorkflowResponse => { + ): WorkflowResponse => { const fields = transform(input, ({ fields }) => { return deduplicate([ ...fields, diff --git a/packages/core/core-flows/src/order/workflows/update-order-change-actions.ts b/packages/core/core-flows/src/order/workflows/update-order-change-actions.ts index 6343c2d6ec..21fd43f6ec 100644 --- a/packages/core/core-flows/src/order/workflows/update-order-change-actions.ts +++ b/packages/core/core-flows/src/order/workflows/update-order-change-actions.ts @@ -10,6 +10,9 @@ import { import { updateOrderChangeActionsStep } from "../steps" export const updateOrderChangeActionsWorkflowId = "update-order-change-actions" +/** + * This workflow updates one or more order change actions. + */ export const updateOrderChangeActionsWorkflow = createWorkflow( updateOrderChangeActionsWorkflowId, ( diff --git a/packages/core/core-flows/src/order/workflows/update-tax-lines.ts b/packages/core/core-flows/src/order/workflows/update-tax-lines.ts index 5f1c2cd317..ce709a12d4 100644 --- a/packages/core/core-flows/src/order/workflows/update-tax-lines.ts +++ b/packages/core/core-flows/src/order/workflows/update-tax-lines.ts @@ -56,7 +56,7 @@ const orderFields = [ "shipping_address.province", ] -type WorkflowInput = { +export type UpdateOrderTaxLinesWorkflowInput = { order_id: string items?: OrderLineItemDTO[] shipping_methods?: OrderShippingMethodDTO[] @@ -64,9 +64,12 @@ type WorkflowInput = { } export const updateOrderTaxLinesWorkflowId = "update-order-tax-lines" +/** + * This workflow updates the tax lines of items and shipping methods in an order. + */ export const updateOrderTaxLinesWorkflow = createWorkflow( updateOrderTaxLinesWorkflowId, - (input: WorkflowData): WorkflowData => { + (input: WorkflowData): WorkflowData => { const order = useRemoteQueryStep({ entry_point: "order", fields: orderFields,