diff --git a/packages/core/core-flows/src/order/workflows/add-line-items.ts b/packages/core/core-flows/src/order/workflows/add-line-items.ts index b65c79ea82..8f9f4f93e3 100644 --- a/packages/core/core-flows/src/order/workflows/add-line-items.ts +++ b/packages/core/core-flows/src/order/workflows/add-line-items.ts @@ -56,6 +56,9 @@ function prepareLineItems(data) { } export const addOrderLineItemsWorkflowId = "order-add-line-items" +/** + * This workflow adds line items to an order. + */ export const addOrderLineItemsWorkflow = createWorkflow( addOrderLineItemsWorkflowId, ( diff --git a/packages/core/core-flows/src/order/workflows/archive-orders.ts b/packages/core/core-flows/src/order/workflows/archive-orders.ts index 470ff4c910..6f349c525c 100644 --- a/packages/core/core-flows/src/order/workflows/archive-orders.ts +++ b/packages/core/core-flows/src/order/workflows/archive-orders.ts @@ -6,15 +6,18 @@ import { } from "@medusajs/workflows-sdk" import { archiveOrdersStep } from "../steps" -type ArchiveOrdersStepInput = { +export type ArchiveOrdersWorkflowInput = { orderIds: string[] } export const archiveOrderWorkflowId = "archive-order-workflow" +/** + * This workflow archives an order. + */ export const archiveOrderWorkflow = createWorkflow( archiveOrderWorkflowId, ( - input: WorkflowData + input: WorkflowData ): WorkflowResponse => { return new WorkflowResponse(archiveOrdersStep(input)) } diff --git a/packages/core/core-flows/src/order/workflows/cancel-order-change.ts b/packages/core/core-flows/src/order/workflows/cancel-order-change.ts index 752f8c99f2..218c780c1c 100644 --- a/packages/core/core-flows/src/order/workflows/cancel-order-change.ts +++ b/packages/core/core-flows/src/order/workflows/cancel-order-change.ts @@ -3,6 +3,9 @@ import { WorkflowData, createWorkflow } from "@medusajs/workflows-sdk" import { cancelOrderChangeStep } from "../steps" export const cancelOrderChangeWorkflowId = "cancel-order-change" +/** + * This workflow cancels an order change. + */ export const cancelOrderChangeWorkflow = createWorkflow( cancelOrderChangeWorkflowId, (input: WorkflowData): WorkflowData => { diff --git a/packages/core/core-flows/src/order/workflows/cancel-order-fulfillment.ts b/packages/core/core-flows/src/order/workflows/cancel-order-fulfillment.ts index 237efa949d..4c47093e3f 100644 --- a/packages/core/core-flows/src/order/workflows/cancel-order-fulfillment.ts +++ b/packages/core/core-flows/src/order/workflows/cancel-order-fulfillment.ts @@ -24,8 +24,11 @@ import { throwIfOrderIsCancelled, } from "../utils/order-validation" -const validateOrder = createStep( - "validate-order", +/** + * This step validates that an order fulfillment can be canceled. + */ +export const cancelOrderFulfillmentValidateOrder = createStep( + "cancel-fulfillment-validate-order", ({ order, input, @@ -109,6 +112,9 @@ function prepareInventoryUpdate({ } export const cancelOrderFulfillmentWorkflowId = "cancel-order-fulfillment" +/** + * This workflow cancels an order's fulfillment. + */ export const cancelOrderFulfillmentWorkflow = createWorkflow( cancelOrderFulfillmentWorkflowId, ( @@ -131,7 +137,7 @@ export const cancelOrderFulfillmentWorkflow = createWorkflow( throw_if_key_not_found: true, }) - validateOrder({ order, input }) + cancelOrderFulfillmentValidateOrder({ order, input }) const fulfillment = transform({ input, order }, ({ input, order }) => { return order.fulfillments.find((f) => f.id === input.fulfillment_id)! diff --git a/packages/core/core-flows/src/order/workflows/cancel-order.ts b/packages/core/core-flows/src/order/workflows/cancel-order.ts index 8df8e732be..9ce542dbeb 100644 --- a/packages/core/core-flows/src/order/workflows/cancel-order.ts +++ b/packages/core/core-flows/src/order/workflows/cancel-order.ts @@ -20,8 +20,11 @@ import { deleteReservationsByLineItemsStep } from "../../reservation/steps" import { cancelOrdersStep } from "../steps/cancel-orders" import { throwIfOrderIsCancelled } from "../utils/order-validation" -const validateOrder = createStep( - "validate-order", +/** + * This step validates that an order can be canceled. + */ +export const cancelValidateOrder = createStep( + "cancel-validate-order", ({ order, }: { @@ -77,6 +80,9 @@ const validateOrder = createStep( ) export const cancelOrderWorkflowId = "cancel-order" +/** + * This workflow cancels an order. + */ export const cancelOrderWorkflow = createWorkflow( cancelOrderWorkflowId, (input: WorkflowData) => { @@ -97,7 +103,7 @@ export const cancelOrderWorkflow = createWorkflow( throw_if_key_not_found: true, }) - validateOrder({ order, input }) + cancelValidateOrder({ order, input }) const lineItemIds = transform({ order }, ({ order }) => { return order.items?.map((i) => i.id) diff --git a/packages/core/core-flows/src/order/workflows/complete-orders.ts b/packages/core/core-flows/src/order/workflows/complete-orders.ts index 44739c59e8..15a3eeb04b 100644 --- a/packages/core/core-flows/src/order/workflows/complete-orders.ts +++ b/packages/core/core-flows/src/order/workflows/complete-orders.ts @@ -7,14 +7,17 @@ import { import { completeOrdersStep } from "../steps" import { AdditionalData } from "@medusajs/types" -type CompleteOrdersStepInput = { +export type CompleteOrdersWorkflowInput = { orderIds: string[] } & AdditionalData export const completeOrderWorkflowId = "complete-order-workflow" +/** + * This workflow completes one or more orders. + */ export const completeOrderWorkflow = createWorkflow( completeOrderWorkflowId, - (input: WorkflowData) => { + (input: WorkflowData) => { const completedOrders = completeOrdersStep(input) const ordersCompleted = createHook("ordersCompleted", { orders: completedOrders, diff --git a/packages/core/core-flows/src/order/workflows/create-fulfillment.ts b/packages/core/core-flows/src/order/workflows/create-fulfillment.ts index fc4dc87db4..6796bc209e 100644 --- a/packages/core/core-flows/src/order/workflows/create-fulfillment.ts +++ b/packages/core/core-flows/src/order/workflows/create-fulfillment.ts @@ -30,8 +30,11 @@ import { throwIfOrderIsCancelled, } from "../utils/order-validation" -const validateOrder = createStep( - "validate-order", +/** + * This step validates that a fulfillment can be created for an order. + */ +export const createFulfillmentValidateOrder = createStep( + "create-fulfillment-validate-order", ( { order, @@ -202,6 +205,9 @@ function prepareInventoryUpdate({ } export const createOrderFulfillmentWorkflowId = "create-order-fulfillment" +/** + * This creates a fulfillment for an order. + */ export const createOrderFulfillmentWorkflow = createWorkflow( createOrderFulfillmentWorkflowId, ( @@ -227,7 +233,7 @@ export const createOrderFulfillmentWorkflow = createWorkflow( throw_if_key_not_found: true, }) - validateOrder({ order, inputItems: input.items }) + createFulfillmentValidateOrder({ order, inputItems: input.items }) const inputItemsMap = transform(input, ({ items }) => { return items.reduce((acc, item) => { diff --git a/packages/core/core-flows/src/order/workflows/create-order-change-actions.ts b/packages/core/core-flows/src/order/workflows/create-order-change-actions.ts index 5f9a1d0585..06991d5180 100644 --- a/packages/core/core-flows/src/order/workflows/create-order-change-actions.ts +++ b/packages/core/core-flows/src/order/workflows/create-order-change-actions.ts @@ -10,6 +10,9 @@ import { import { createOrderChangeActionsStep } from "../steps" export const createOrderChangeActionsWorkflowId = "create-order-change-actions" +/** + * This workflow creates order change actions. + */ export const createOrderChangeActionsWorkflow = createWorkflow( createOrderChangeActionsWorkflowId, ( diff --git a/packages/core/core-flows/src/order/workflows/create-order-change.ts b/packages/core/core-flows/src/order/workflows/create-order-change.ts index f07af69b6a..7b0e36e11a 100644 --- a/packages/core/core-flows/src/order/workflows/create-order-change.ts +++ b/packages/core/core-flows/src/order/workflows/create-order-change.ts @@ -7,6 +7,9 @@ import { import { createOrderChangeStep } from "../steps" export const createOrderChangeWorkflowId = "create-order-change" +/** + * This workflow creates an order change. + */ export const createOrderChangeWorkflow = createWorkflow( createOrderChangeWorkflowId, ( diff --git a/packages/core/core-flows/src/order/workflows/create-orders.ts b/packages/core/core-flows/src/order/workflows/create-orders.ts index 8ab4758ca8..e8c930d2c4 100644 --- a/packages/core/core-flows/src/order/workflows/create-orders.ts +++ b/packages/core/core-flows/src/order/workflows/create-orders.ts @@ -84,6 +84,9 @@ function getOrderInput(data) { } export const createOrdersWorkflowId = "create-orders" +/** + * This workflow creates an order. + */ export const createOrdersWorkflow = createWorkflow( createOrdersWorkflowId, (input: WorkflowData) => { diff --git a/packages/core/core-flows/src/order/workflows/create-shipment.ts b/packages/core/core-flows/src/order/workflows/create-shipment.ts index 2658960386..ac26c5ac19 100644 --- a/packages/core/core-flows/src/order/workflows/create-shipment.ts +++ b/packages/core/core-flows/src/order/workflows/create-shipment.ts @@ -22,8 +22,11 @@ import { throwIfOrderIsCancelled, } from "../utils/order-validation" -const validateOrder = createStep( - "validate-order", +/** + * This step validates that a shipment can be created for an order. + */ +export const createShipmentValidateOrder = createStep( + "create-shipment-validate-order", ({ order, input, @@ -74,6 +77,9 @@ function prepareRegisterShipmentData({ } export const createOrderShipmentWorkflowId = "create-order-shipment" +/** + * This workflow creates a shipment for an order. + */ export const createOrderShipmentWorkflow = createWorkflow( createOrderShipmentWorkflowId, ( @@ -96,7 +102,7 @@ export const createOrderShipmentWorkflow = createWorkflow( throw_if_key_not_found: true, }) - validateOrder({ order, input }) + createShipmentValidateOrder({ order, input }) const fulfillmentData = transform({ input }, ({ input }) => { return { diff --git a/packages/core/core-flows/src/order/workflows/return/begin-receive-return.ts b/packages/core/core-flows/src/order/workflows/return/begin-receive-return.ts index ee1d30c071..0735ae2c07 100644 --- a/packages/core/core-flows/src/order/workflows/return/begin-receive-return.ts +++ b/packages/core/core-flows/src/order/workflows/return/begin-receive-return.ts @@ -15,7 +15,10 @@ import { useRemoteQueryStep } from "../../../common" import { createOrderChangeStep } from "../../steps" import { throwIfIsCancelled } from "../../utils/order-validation" -const validationStep = createStep( +/** + * This step validates that a return can be received. + */ +export const beginReceiveReturnValidationStep = createStep( "begin-receive-return-validation", async function ( { @@ -33,6 +36,9 @@ const validationStep = createStep( ) export const beginReceiveReturnWorkflowId = "begin-receive-return" +/** + * This workflow requests return receival. + */ export const beginReceiveReturnWorkflow = createWorkflow( beginReceiveReturnWorkflowId, function ( @@ -54,7 +60,7 @@ export const beginReceiveReturnWorkflow = createWorkflow( throw_if_key_not_found: true, }).config({ name: "order-query" }) - validationStep({ order, orderReturn }) + beginReceiveReturnValidationStep({ order, orderReturn }) const orderChangeInput = transform( { orderReturn, order, input }, diff --git a/packages/core/core-flows/src/order/workflows/return/begin-return.ts b/packages/core/core-flows/src/order/workflows/return/begin-return.ts index 235ac133fc..94d0bbcfba 100644 --- a/packages/core/core-flows/src/order/workflows/return/begin-return.ts +++ b/packages/core/core-flows/src/order/workflows/return/begin-return.ts @@ -10,7 +10,10 @@ import { useRemoteQueryStep } from "../../../common" import { createOrderChangeStep, createReturnsStep } from "../../steps" import { throwIfOrderIsCancelled } from "../../utils/order-validation" -const validationStep = createStep( +/** + * This step validates that a return can be created for an order. + */ +export const beginReturnOrderValidationStep = createStep( "begin-return-order-validation", async function ({ order }: { order: OrderDTO }) { throwIfOrderIsCancelled({ order }) @@ -18,6 +21,9 @@ const validationStep = createStep( ) export const beginReturnOrderWorkflowId = "begin-return-order" +/** + * This workflow requests a return. + */ export const beginReturnOrderWorkflow = createWorkflow( beginReturnOrderWorkflowId, function ( @@ -31,7 +37,7 @@ export const beginReturnOrderWorkflow = createWorkflow( throw_if_key_not_found: true, }) - validationStep({ order }) + beginReturnOrderValidationStep({ order }) const created = createReturnsStep([ { diff --git a/packages/core/core-flows/src/order/workflows/return/cancel-receive-return.ts b/packages/core/core-flows/src/order/workflows/return/cancel-receive-return.ts index a1201c4ef0..e112aa368d 100644 --- a/packages/core/core-flows/src/order/workflows/return/cancel-receive-return.ts +++ b/packages/core/core-flows/src/order/workflows/return/cancel-receive-return.ts @@ -12,7 +12,10 @@ import { throwIfOrderChangeIsNotActive, } from "../../utils/order-validation" -const validationStep = createStep( +/** + * This step validates that a return receival can be canceled. + */ +export const cancelReceiveReturnValidationStep = createStep( "validate-cancel-return-shipping-method", async function ({ order, @@ -30,6 +33,9 @@ const validationStep = createStep( ) export const cancelReturnReceiveWorkflowId = "cancel-receive-return" +/** + * This workflow cancels a return receival. + */ export const cancelReturnReceiveWorkflow = createWorkflow( cancelReturnReceiveWorkflowId, function (input: { return_id: string }): WorkflowData { @@ -62,7 +68,7 @@ export const cancelReturnReceiveWorkflow = createWorkflow( list: false, }).config({ name: "order-change-query" }) - validationStep({ order, orderReturn, orderChange }) + cancelReceiveReturnValidationStep({ order, orderReturn, orderChange }) deleteOrderChangesStep({ ids: [orderChange.id] }) } diff --git a/packages/core/core-flows/src/order/workflows/return/cancel-request-return.ts b/packages/core/core-flows/src/order/workflows/return/cancel-request-return.ts index 58daadf59a..060497e9e9 100644 --- a/packages/core/core-flows/src/order/workflows/return/cancel-request-return.ts +++ b/packages/core/core-flows/src/order/workflows/return/cancel-request-return.ts @@ -18,11 +18,14 @@ import { throwIfOrderChangeIsNotActive, } from "../../utils/order-validation" -type WorkflowInput = { +export type CancelRequestReturnWorkflowInput = { return_id: string } -const validationStep = createStep( +/** + * This step validates that a requested return can be canceled. + */ +export const cancelRequestReturnValidationStep = createStep( "validate-cancel-return-shipping-method", async function ({ order, @@ -40,9 +43,12 @@ const validationStep = createStep( ) export const cancelReturnRequestWorkflowId = "cancel-return-request" +/** + * This workflow cancels a requested return. + */ export const cancelReturnRequestWorkflow = createWorkflow( cancelReturnRequestWorkflowId, - function (input: WorkflowInput): WorkflowData { + function (input: CancelRequestReturnWorkflowInput): WorkflowData { const orderReturn: ReturnDTO = useRemoteQueryStep({ entry_point: "return", fields: ["id", "status", "order_id", "canceled_at"], @@ -72,7 +78,7 @@ export const cancelReturnRequestWorkflow = createWorkflow( list: false, }).config({ name: "order-change-query" }) - validationStep({ order, orderReturn, orderChange }) + cancelRequestReturnValidationStep({ order, orderReturn, orderChange }) const shippingToRemove = transform( { orderChange, input }, diff --git a/packages/core/core-flows/src/order/workflows/return/cancel-return.ts b/packages/core/core-flows/src/order/workflows/return/cancel-return.ts index 2a8df8c616..35f74a0417 100644 --- a/packages/core/core-flows/src/order/workflows/return/cancel-return.ts +++ b/packages/core/core-flows/src/order/workflows/return/cancel-return.ts @@ -14,7 +14,10 @@ import { useRemoteQueryStep } from "../../../common" import { cancelOrderReturnStep } from "../../steps" import { throwIfIsCancelled } from "../../utils/order-validation" -const validateOrder = createStep( +/** + * This step validates that a return can be canceled. + */ +export const cancelReturnValidateOrder = createStep( "validate-return", ({ orderReturn, @@ -57,6 +60,9 @@ const validateOrder = createStep( ) export const cancelReturnWorkflowId = "cancel-return" +/** + * This workflow cancels a return. + */ export const cancelReturnWorkflow = createWorkflow( cancelReturnWorkflowId, ( @@ -78,7 +84,7 @@ export const cancelReturnWorkflow = createWorkflow( throw_if_key_not_found: true, }) - validateOrder({ orderReturn, input }) + cancelReturnValidateOrder({ orderReturn, input }) cancelOrderReturnStep({ return_id: orderReturn.id, diff --git a/packages/core/core-flows/src/order/workflows/return/confirm-receive-return-request.ts b/packages/core/core-flows/src/order/workflows/return/confirm-receive-return-request.ts index db8806e020..8fddf29552 100644 --- a/packages/core/core-flows/src/order/workflows/return/confirm-receive-return-request.ts +++ b/packages/core/core-flows/src/order/workflows/return/confirm-receive-return-request.ts @@ -33,11 +33,14 @@ import { throwIfOrderChangeIsNotActive, } from "../../utils/order-validation" -type WorkflowInput = { +export type ConfirmReceiveReturnRequestWorkflowInput = { return_id: string } -const validationStep = createStep( +/** + * This step validates that a return receival can be confirmed. + */ +export const confirmReceiveReturnValidationStep = createStep( "validate-confirm-return-receive", async function ({ order, @@ -126,9 +129,12 @@ function prepareInventoryUpdate({ orderReturn, returnedQuantityMap }) { } export const confirmReturnReceiveWorkflowId = "confirm-return-receive" +/** + * This workflow confirms a return receival request. + */ export const confirmReturnReceiveWorkflow = createWorkflow( confirmReturnReceiveWorkflowId, - function (input: WorkflowInput): WorkflowResponse { + function (input: ConfirmReceiveReturnRequestWorkflowInput): WorkflowResponse { const orderReturn: ReturnDTO = useRemoteQueryStep({ entry_point: "return", fields: [ @@ -267,7 +273,7 @@ export const confirmReturnReceiveWorkflow = createWorkflow( prepareInventoryUpdate ) - validationStep({ order, orderReturn, orderChange }) + confirmReceiveReturnValidationStep({ order, orderReturn, orderChange }) parallelize( updateReturnsStep([updateReturn]), diff --git a/packages/core/core-flows/src/order/workflows/return/confirm-return-request.ts b/packages/core/core-flows/src/order/workflows/return/confirm-return-request.ts index 253fb4944f..4945c7b1ee 100644 --- a/packages/core/core-flows/src/order/workflows/return/confirm-return-request.ts +++ b/packages/core/core-flows/src/order/workflows/return/confirm-return-request.ts @@ -28,11 +28,14 @@ import { throwIfOrderChangeIsNotActive, } from "../../utils/order-validation" -type WorkflowInput = { +export type ConfirmReturnRequestWorkflowInput = { return_id: string } -const validationStep = createStep( +/** + * This step validates that a return request can be confirmed. + */ +export const confirmReturnRequestValidationStep = createStep( "validate-confirm-return-request", async function ({ order, @@ -129,9 +132,12 @@ function extractReturnShippingOptionId({ orderPreview, orderReturn }) { } export const confirmReturnRequestWorkflowId = "confirm-return-request" +/** + * This workflow confirms a return request. + */ export const confirmReturnRequestWorkflow = createWorkflow( confirmReturnRequestWorkflowId, - function (input: WorkflowInput): WorkflowResponse { + function (input: ConfirmReturnRequestWorkflowInput): WorkflowResponse { const orderReturn: ReturnDTO = useRemoteQueryStep({ entry_point: "return", fields: ["id", "status", "order_id", "location_id", "canceled_at"], @@ -184,7 +190,7 @@ export const confirmReturnRequestWorkflow = createWorkflow( ) }) - validationStep({ order, orderReturn, orderChange }) + confirmReturnRequestValidationStep({ order, orderReturn, orderChange }) const orderPreview = previewOrderChangeStep(order.id) diff --git a/packages/core/core-flows/src/order/workflows/return/create-complete-return.ts b/packages/core/core-flows/src/order/workflows/return/create-complete-return.ts index e884596422..a24a4f2cb9 100644 --- a/packages/core/core-flows/src/order/workflows/return/create-complete-return.ts +++ b/packages/core/core-flows/src/order/workflows/return/create-complete-return.ts @@ -198,7 +198,10 @@ function prepareReturnShippingOptionQueryVariables({ return variables } -const validationStep = createStep( +/** + * This step validates that a return can be created and completed for an order. + */ +export const createCompleteReturnValidationStep = createStep( "create-return-order-validation", async function ( { @@ -229,6 +232,9 @@ const validationStep = createStep( export const createAndCompleteReturnOrderWorkflowId = "create-complete-return-order" +/** + * This workflow creates and completes a return. + */ export const createAndCompleteReturnOrderWorkflow = createWorkflow( createAndCompleteReturnOrderWorkflowId, function ( @@ -250,7 +256,7 @@ export const createAndCompleteReturnOrderWorkflow = createWorkflow( throw_if_key_not_found: true, }) - validationStep({ order, input }) + createCompleteReturnValidationStep({ order, input }) const returnShippingOptionsVariables = transform( { input, order }, diff --git a/packages/core/core-flows/src/order/workflows/return/create-return-shipping-method.ts b/packages/core/core-flows/src/order/workflows/return/create-return-shipping-method.ts index a13734bf03..c3697783f1 100644 --- a/packages/core/core-flows/src/order/workflows/return/create-return-shipping-method.ts +++ b/packages/core/core-flows/src/order/workflows/return/create-return-shipping-method.ts @@ -21,7 +21,10 @@ import { throwIfOrderChangeIsNotActive, } from "../../utils/order-validation" -const validationStep = createStep( +/** + * This step validates that a shipping method can be created for a return. + */ +export const createReturnShippingMethodValidationStep = createStep( "validate-create-return-shipping-method", async function ({ order, @@ -40,6 +43,9 @@ const validationStep = createStep( export const createReturnShippingMethodWorkflowId = "create-return-shipping-method" +/** + * This workflow creates a shipping method for a return. + */ export const createReturnShippingMethodWorkflow = createWorkflow( createReturnShippingMethodWorkflowId, function (input: { @@ -94,7 +100,7 @@ export const createReturnShippingMethodWorkflow = createWorkflow( list: false, }).config({ name: "order-change-query" }) - validationStep({ order, orderReturn, orderChange }) + createReturnShippingMethodValidationStep({ order, orderReturn, orderChange }) const shippingMethodInput = transform( { diff --git a/packages/core/core-flows/src/order/workflows/return/dismiss-item-return-request.ts b/packages/core/core-flows/src/order/workflows/return/dismiss-item-return-request.ts index 2f068e114a..7b109e0bbe 100644 --- a/packages/core/core-flows/src/order/workflows/return/dismiss-item-return-request.ts +++ b/packages/core/core-flows/src/order/workflows/return/dismiss-item-return-request.ts @@ -21,7 +21,10 @@ import { throwIfOrderChangeIsNotActive, } from "../../utils/order-validation" -const validationStep = createStep( +/** + * This step validates that a return request can have its items dismissed. + */ +export const dismissItemReturnRequestValidationStep = createStep( "dismiss-item-return-request-validation", async function ( { @@ -45,6 +48,9 @@ const validationStep = createStep( ) export const dismissItemReturnRequestWorkflowId = "dismiss-item-return-request" +/** + * This workflow dismisses items from a return request. + */ export const dismissItemReturnRequestWorkflow = createWorkflow( dismissItemReturnRequestWorkflowId, function ( @@ -79,7 +85,7 @@ export const dismissItemReturnRequestWorkflow = createWorkflow( list: false, }).config({ name: "order-change-query" }) - validationStep({ order, items: input.items, orderReturn, orderChange }) + dismissItemReturnRequestValidationStep({ order, items: input.items, orderReturn, orderChange }) const orderChangeActionInput = transform( { order, orderChange, orderReturn, items: input.items }, diff --git a/packages/core/core-flows/src/order/workflows/return/receive-complete-return.ts b/packages/core/core-flows/src/order/workflows/return/receive-complete-return.ts index 0a86f423b8..dc200379b3 100644 --- a/packages/core/core-flows/src/order/workflows/return/receive-complete-return.ts +++ b/packages/core/core-flows/src/order/workflows/return/receive-complete-return.ts @@ -14,7 +14,10 @@ import { throwIfItemsDoesNotExistsInReturn, } from "../../utils/order-validation" -const validationStep = createStep( +/** + * This step validates that a return can be received and completed. + */ +export const receiveCompleteReturnValidationStep = createStep( "receive-return-order-validation", async function ( { @@ -32,6 +35,9 @@ const validationStep = createStep( ) export const receiveAndCompleteReturnOrderWorkflowId = "receive-return-order" +/** + * This workflow marks a return as received and completes it. + */ export const receiveAndCompleteReturnOrderWorkflow = createWorkflow( receiveAndCompleteReturnOrderWorkflowId, function ( @@ -45,7 +51,7 @@ export const receiveAndCompleteReturnOrderWorkflow = createWorkflow( throw_if_key_not_found: true, }) - validationStep({ orderReturn, input }) + receiveCompleteReturnValidationStep({ orderReturn, input }) return new WorkflowResponse(receiveReturnStep(input)) } diff --git a/packages/core/core-flows/src/order/workflows/return/receive-item-return-request.ts b/packages/core/core-flows/src/order/workflows/return/receive-item-return-request.ts index bb4e673fe3..22d6fb8945 100644 --- a/packages/core/core-flows/src/order/workflows/return/receive-item-return-request.ts +++ b/packages/core/core-flows/src/order/workflows/return/receive-item-return-request.ts @@ -21,7 +21,10 @@ import { throwIfOrderChangeIsNotActive, } from "../../utils/order-validation" -const validationStep = createStep( +/** + * This step validates that a return's items can be marked as received. + */ +export const receiveItemReturnRequestValidationStep = createStep( "receive-item-return-request-validation", async function ( { @@ -45,6 +48,9 @@ const validationStep = createStep( ) export const receiveItemReturnRequestWorkflowId = "receive-item-return-request" +/** + * This workflow marks return items as received. + */ export const receiveItemReturnRequestWorkflow = createWorkflow( receiveItemReturnRequestWorkflowId, function ( @@ -79,7 +85,7 @@ export const receiveItemReturnRequestWorkflow = createWorkflow( list: false, }).config({ name: "order-change-query" }) - validationStep({ order, items: input.items, orderReturn, orderChange }) + receiveItemReturnRequestValidationStep({ order, items: input.items, orderReturn, orderChange }) const orderChangeActionInput = transform( { order, orderChange, orderReturn, items: input.items }, diff --git a/packages/core/core-flows/src/order/workflows/return/remove-item-receive-return-action.ts b/packages/core/core-flows/src/order/workflows/return/remove-item-receive-return-action.ts index 30bb798b52..0335d015e7 100644 --- a/packages/core/core-flows/src/order/workflows/return/remove-item-receive-return-action.ts +++ b/packages/core/core-flows/src/order/workflows/return/remove-item-receive-return-action.ts @@ -22,7 +22,10 @@ import { throwIfOrderChangeIsNotActive, } from "../../utils/order-validation" -const validationStep = createStep( +/** + * This step validates that a return receival's item can be removed. + */ +export const removeItemReceiveReturnActionValidationStep = createStep( "remove-item-receive-return-action-validation", async function ({ order, @@ -62,6 +65,9 @@ const validationStep = createStep( export const removeItemReceiveReturnActionWorkflowId = "remove-item-receive-return-action" +/** + * This workflow removes an item from a return receival. + */ export const removeItemReceiveReturnActionWorkflow = createWorkflow( removeItemReceiveReturnActionWorkflowId, function ( @@ -96,7 +102,7 @@ export const removeItemReceiveReturnActionWorkflow = createWorkflow( list: false, }).config({ name: "order-change-query" }) - validationStep({ order, input, orderReturn, orderChange }) + removeItemReceiveReturnActionValidationStep({ order, input, orderReturn, orderChange }) deleteOrderChangeActionsStep({ ids: [input.action_id] }) diff --git a/packages/core/core-flows/src/order/workflows/return/remove-item-return-action.ts b/packages/core/core-flows/src/order/workflows/return/remove-item-return-action.ts index 99c25d341e..e230930027 100644 --- a/packages/core/core-flows/src/order/workflows/return/remove-item-return-action.ts +++ b/packages/core/core-flows/src/order/workflows/return/remove-item-return-action.ts @@ -22,7 +22,10 @@ import { throwIfOrderChangeIsNotActive, } from "../../utils/order-validation" -const validationStep = createStep( +/** + * This step validates that a return item can be removed. + */ +export const removeReturnItemActionValidationStep = createStep( "remove-item-return-action-validation", async function ({ order, @@ -56,6 +59,9 @@ const validationStep = createStep( ) export const removeItemReturnActionWorkflowId = "remove-item-return-action" +/** + * This workflow removes a return item. + */ export const removeItemReturnActionWorkflow = createWorkflow( removeItemReturnActionWorkflowId, function ( @@ -100,7 +106,7 @@ export const removeItemReturnActionWorkflow = createWorkflow( list: false, }).config({ name: "order-change-query" }) - validationStep({ order, input, orderReturn, orderChange }) + removeReturnItemActionValidationStep({ order, input, orderReturn, orderChange }) deleteOrderChangeActionsStep({ ids: [input.action_id] }) diff --git a/packages/core/core-flows/src/order/workflows/return/remove-return-shipping-method.ts b/packages/core/core-flows/src/order/workflows/return/remove-return-shipping-method.ts index 801874d14e..d53c48cb2f 100644 --- a/packages/core/core-flows/src/order/workflows/return/remove-return-shipping-method.ts +++ b/packages/core/core-flows/src/order/workflows/return/remove-return-shipping-method.ts @@ -23,7 +23,10 @@ import { throwIfOrderChangeIsNotActive, } from "../../utils/order-validation" -const validationStep = createStep( +/** + * This step validates that a shipping method can be removed from a return. + */ +export const removeReturnShippingMethodValidationStep = createStep( "validate-remove-return-shipping-method", async function ({ orderChange, @@ -55,6 +58,9 @@ const validationStep = createStep( export const removeReturnShippingMethodWorkflowId = "remove-return-shipping-method" +/** + * This workflow removes a shipping method from a return. + */ export const removeReturnShippingMethodWorkflow = createWorkflow( removeReturnShippingMethodWorkflowId, function ( @@ -81,7 +87,7 @@ export const removeReturnShippingMethodWorkflow = createWorkflow( list: false, }).config({ name: "order-change-query" }) - validationStep({ orderReturn, orderChange, input }) + removeReturnShippingMethodValidationStep({ orderReturn, orderChange, input }) const dataToRemove = transform( { orderChange, input }, diff --git a/packages/core/core-flows/src/order/workflows/return/request-item-return.ts b/packages/core/core-flows/src/order/workflows/return/request-item-return.ts index 313b35dead..0bcbf07e7d 100644 --- a/packages/core/core-flows/src/order/workflows/return/request-item-return.ts +++ b/packages/core/core-flows/src/order/workflows/return/request-item-return.ts @@ -22,7 +22,10 @@ import { } from "../../utils/order-validation" import { validateReturnReasons } from "../../utils/validate-return-reason" -const validationStep = createStep( +/** + * This step validates that itens can be added to a return. + */ +export const requestItemReturnValidationStep = createStep( "request-item-return-validation", async function ( { @@ -51,6 +54,9 @@ const validationStep = createStep( ) export const requestItemReturnWorkflowId = "request-item-return" +/** + * This workflow adds items to a return. + */ export const requestItemReturnWorkflow = createWorkflow( requestItemReturnWorkflowId, function ( @@ -85,7 +91,7 @@ export const requestItemReturnWorkflow = createWorkflow( list: false, }).config({ name: "order-change-query" }) - validationStep({ order, items: input.items, orderReturn, orderChange }) + requestItemReturnValidationStep({ order, items: input.items, orderReturn, orderChange }) const orderChangeActionInput = transform( { order, orderChange, orderReturn, items: input.items }, diff --git a/packages/core/core-flows/src/order/workflows/return/update-receive-item-return-request.ts b/packages/core/core-flows/src/order/workflows/return/update-receive-item-return-request.ts index 551d96a8f2..22177e4149 100644 --- a/packages/core/core-flows/src/order/workflows/return/update-receive-item-return-request.ts +++ b/packages/core/core-flows/src/order/workflows/return/update-receive-item-return-request.ts @@ -23,7 +23,10 @@ import { throwIfOrderChangeIsNotActive, } from "../../utils/order-validation" -const validationStep = createStep( +/** + * This step validates that an item can be updated in a return receival request. + */ +export const updateReceiveItemReturnRequestValidationStep = createStep( "update-receive-item-return-request-validation", async function ( { @@ -66,6 +69,9 @@ const validationStep = createStep( export const updateReceiveItemReturnRequestWorkflowId = "update-receive-item-return-request" +/** + * This workflow updates an item in a return receival request. + */ export const updateReceiveItemReturnRequestWorkflow = createWorkflow( updateReceiveItemReturnRequestWorkflowId, function ( @@ -100,7 +106,7 @@ export const updateReceiveItemReturnRequestWorkflow = createWorkflow( list: false, }).config({ name: "order-change-query" }) - validationStep({ order, input, orderReturn, orderChange }) + updateReceiveItemReturnRequestValidationStep({ order, input, orderReturn, orderChange }) const updateData = transform( { orderChange, input }, diff --git a/packages/core/core-flows/src/order/workflows/return/update-request-item-return.ts b/packages/core/core-flows/src/order/workflows/return/update-request-item-return.ts index 2218e77ce5..a67d1f9975 100644 --- a/packages/core/core-flows/src/order/workflows/return/update-request-item-return.ts +++ b/packages/core/core-flows/src/order/workflows/return/update-request-item-return.ts @@ -24,7 +24,10 @@ import { } from "../../utils/order-validation" import { validateReturnReasons } from "../../utils/validate-return-reason" -const validationStep = createStep( +/** + * This step validates that an item in a return can be updated. + */ +export const updateRequestItemReturnValidationStep = createStep( "update-request-item-return-validation", async function ( { @@ -71,6 +74,9 @@ const validationStep = createStep( ) export const updateRequestItemReturnWorkflowId = "update-request-item-return" +/** + * This workflow updates an item in a return. + */ export const updateRequestItemReturnWorkflow = createWorkflow( updateRequestItemReturnWorkflowId, function ( @@ -105,7 +111,7 @@ export const updateRequestItemReturnWorkflow = createWorkflow( list: false, }).config({ name: "order-change-query" }) - validationStep({ order, input, orderReturn, orderChange }) + updateRequestItemReturnValidationStep({ order, input, orderReturn, orderChange }) const updateData = transform( { orderChange, input }, diff --git a/packages/core/core-flows/src/order/workflows/return/update-return-shipping-method.ts b/packages/core/core-flows/src/order/workflows/return/update-return-shipping-method.ts index 9d909b24cc..772c61705d 100644 --- a/packages/core/core-flows/src/order/workflows/return/update-return-shipping-method.ts +++ b/packages/core/core-flows/src/order/workflows/return/update-return-shipping-method.ts @@ -25,7 +25,10 @@ import { throwIfOrderChangeIsNotActive, } from "../../utils/order-validation" -const validationStep = createStep( +/** + * This step validates that a return's shipping method can be updated. + */ +export const updateReturnShippingMethodValidationStep = createStep( "validate-update-return-shipping-method", async function ({ orderChange, @@ -57,6 +60,9 @@ const validationStep = createStep( export const updateReturnShippingMethodWorkflowId = "update-return-shipping-method" +/** + * This workflow updates the shipping method of a return. + */ export const updateReturnShippingMethodWorkflow = createWorkflow( updateReturnShippingMethodWorkflowId, function ( @@ -83,7 +89,7 @@ export const updateReturnShippingMethodWorkflow = createWorkflow( list: false, }).config({ name: "order-change-query" }) - validationStep({ orderReturn, orderChange, input }) + updateReturnShippingMethodValidationStep({ orderReturn, orderChange, input }) const updateData = transform( { orderChange, input }, diff --git a/packages/core/core-flows/src/order/workflows/return/update-return.ts b/packages/core/core-flows/src/order/workflows/return/update-return.ts index ea1d3a37f2..91b2a596f9 100644 --- a/packages/core/core-flows/src/order/workflows/return/update-return.ts +++ b/packages/core/core-flows/src/order/workflows/return/update-return.ts @@ -20,7 +20,10 @@ import { throwIfOrderChangeIsNotActive, } from "../../utils/order-validation" -const validationStep = createStep( +/** + * This step validates that a return can be updated + */ +export const updateReturnValidationStep = createStep( "validate-update-return", async function ({ orderChange, @@ -35,6 +38,9 @@ const validationStep = createStep( ) export const updateReturnWorkflowId = "update-return" +/** + * This workflow updates a return. + */ export const updateReturnWorkflow = createWorkflow( updateReturnWorkflowId, function ( @@ -61,7 +67,7 @@ export const updateReturnWorkflow = createWorkflow( list: false, }).config({ name: "order-change-query" }) - validationStep({ orderReturn, orderChange }) + updateReturnValidationStep({ orderReturn, orderChange }) const updateData = transform({ input }, ({ input }) => { return {