UNPKG

@medusajs/core-flows

Version:

Set of workflow definitions for Medusa

133 lines 5.38 kB
"use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.updateClaimAddItemWorkflow = exports.updateClaimAddItemWorkflowId = exports.updateClaimAddItemValidationStep = void 0; const utils_1 = require("@medusajs/framework/utils"); const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk"); const common_1 = require("../../../common"); const steps_1 = require("../../steps"); const order_validation_1 = require("../../utils/order-validation"); const refresh_shipping_1 = require("./refresh-shipping"); /** * This step validates that a claim's new or outbound item can be updated. * If the order, claim, or order change is canceled, no action is adding the item, * or the action is not adding an outbound item, the step will throw an error. * * :::note * * You can retrieve an order, order claim, and order change details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query), * or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep). * * ::: * * @example * const data = updateClaimAddItemValidationStep({ * order: { * id: "order_123", * // other order details... * }, * orderChange: { * id: "orch_123", * // other order change details... * }, * orderClaim: { * id: "claim_123", * // other order claim details... * }, * input: { * claim_id: "claim_123", * action_id: "orchact_123", * data: { * quantity: 1, * } * } * }) */ exports.updateClaimAddItemValidationStep = (0, workflows_sdk_1.createStep)("update-claim-add-item-validation", async function ({ order, orderChange, orderClaim, input, }, context) { (0, order_validation_1.throwIfIsCancelled)(order, "Order"); (0, order_validation_1.throwIfIsCancelled)(orderClaim, "Claim"); (0, order_validation_1.throwIfOrderChangeIsNotActive)({ orderChange }); const associatedAction = (orderChange.actions ?? []).find((a) => a.id === input.action_id); if (!associatedAction) { throw new Error(`No request to add item for claim ${input.claim_id} in order change ${orderChange.id}`); } else if (associatedAction.action !== utils_1.ChangeActionType.ITEM_ADD) { throw new Error(`Action ${associatedAction.id} is not adding an item`); } }); exports.updateClaimAddItemWorkflowId = "update-claim-add-item"; /** * This workflow updates a claim's new or outbound item. It's used by the * [Update Outbound Item API Route](https://docs.medusajs.com/api/admin#claims_postclaimsidoutbounditemsaction_id). * * You can use this workflow within your customizations or your own custom workflows, allowing you to update a claim's new or outbound item * in your custom flows. * * @example * const { result } = await updateClaimAddItemWorkflow(container) * .run({ * input: { * claim_id: "claim_123", * action_id: "orchact_123", * data: { * quantity: 1, * } * } * }) * * @summary * * Update a claim's new or outbound item. */ exports.updateClaimAddItemWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.updateClaimAddItemWorkflowId, function (input) { const orderClaim = (0, common_1.useRemoteQueryStep)({ entry_point: "order_claim", fields: ["id", "status", "order_id", "canceled_at"], variables: { id: input.claim_id }, list: false, throw_if_key_not_found: true, }); const order = (0, common_1.useRemoteQueryStep)({ entry_point: "orders", fields: ["id", "status", "canceled_at", "items.*"], variables: { id: orderClaim.order_id }, list: false, throw_if_key_not_found: true, }).config({ name: "order-query" }); const orderChange = (0, common_1.useRemoteQueryStep)({ entry_point: "order_change", fields: ["id", "status", "version", "actions.*"], variables: { filters: { order_id: orderClaim.order_id, claim_id: orderClaim.id, status: [utils_1.OrderChangeStatus.PENDING, utils_1.OrderChangeStatus.REQUESTED], }, }, list: false, }).config({ name: "order-change-query" }); (0, exports.updateClaimAddItemValidationStep)({ order, input, orderClaim, orderChange }); const updateData = (0, workflows_sdk_1.transform)({ orderChange, input }, ({ input, orderChange }) => { const originalAction = (orderChange.actions ?? []).find((a) => a.id === input.action_id); const data = input.data; return { id: input.action_id, details: { quantity: data.quantity ?? originalAction.details?.quantity, }, internal_note: data.internal_note, }; }); (0, steps_1.updateOrderChangeActionsStep)([updateData]); const refreshArgs = (0, workflows_sdk_1.transform)({ orderChange, orderClaim }, ({ orderChange, orderClaim }) => { return { order_change_id: orderChange.id, claim_id: orderClaim.id, order_id: orderClaim.order_id, }; }); refresh_shipping_1.refreshClaimShippingWorkflow.runAsStep({ input: refreshArgs, }); return new workflows_sdk_1.WorkflowResponse((0, steps_1.previewOrderChangeStep)(order.id)); }); //# sourceMappingURL=update-claim-add-item.js.map