@medusajs/core-flows
Version:
Set of workflow definitions for Medusa
151 lines • 6.13 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.orderExchangeAddNewItemWorkflow = exports.orderExchangeAddNewItemWorkflowId = exports.exchangeAddNewItemValidationStep = void 0;
const utils_1 = require("@medusajs/framework/utils");
const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
const common_1 = require("../../../common");
const preview_order_change_1 = require("../../steps/preview-order-change");
const order_validation_1 = require("../../utils/order-validation");
const add_line_items_1 = require("../add-line-items");
const create_order_change_actions_1 = require("../create-order-change-actions");
const update_tax_lines_1 = require("../update-tax-lines");
const refresh_shipping_1 = require("./refresh-shipping");
/**
* This step validates that new or outbound items can be added to an exchange.
* If the order or exchange is canceled, or the order change is not active, the step will throw an error.
*
* :::note
*
* You can retrieve an order, order exchange, 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 = exchangeAddNewItemValidationStep({
* order: {
* id: "order_123",
* // other order details...
* },
* orderChange: {
* id: "orch_123",
* // other order change details...
* },
* orderExchange: {
* id: "exchange_123",
* // other order exchange details...
* },
* })
*/
exports.exchangeAddNewItemValidationStep = (0, workflows_sdk_1.createStep)("exchange-add-new-item-validation", async function ({ order, orderChange, orderExchange, }) {
(0, order_validation_1.throwIfIsCancelled)(order, "Order");
(0, order_validation_1.throwIfIsCancelled)(orderExchange, "Exchange");
(0, order_validation_1.throwIfOrderChangeIsNotActive)({ orderChange });
});
exports.orderExchangeAddNewItemWorkflowId = "exchange-add-new-item";
/**
* This workflow adds new or outbound items to an exchange. It's used by the
* [Add Outbound Items Admin API Route](https://docs.medusajs.com/api/admin#exchanges_postexchangesidoutbounditems).
*
* You can use this workflow within your customizations or your own custom workflows, allowing you to add new or outbound items
* to an exchange in your custom flow.
*
* @example
* const { result } = await orderExchangeAddNewItemWorkflow(container)
* .run({
* input: {
* exchange_id: "exchange_123",
* items: [
* {
* variant_id: "variant_123",
* quantity: 1,
* }
* ]
* }
* })
*
* @summary
*
* Add new or outbound items to an exchange.
*/
exports.orderExchangeAddNewItemWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.orderExchangeAddNewItemWorkflowId, function (input) {
const orderExchange = (0, common_1.useRemoteQueryStep)({
entry_point: "order_exchange",
fields: ["id", "order_id", "canceled_at"],
variables: { id: input.exchange_id },
list: false,
throw_if_key_not_found: true,
}).config({ name: "exchange-query" });
const order = (0, common_1.useRemoteQueryStep)({
entry_point: "orders",
fields: ["id", "status", "canceled_at", "items.*"],
variables: { id: orderExchange.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"],
variables: {
filters: {
order_id: orderExchange.order_id,
exchange_id: orderExchange.id,
status: [utils_1.OrderChangeStatus.PENDING, utils_1.OrderChangeStatus.REQUESTED],
},
},
list: false,
}).config({ name: "order-change-query" });
(0, exports.exchangeAddNewItemValidationStep)({
order,
orderExchange,
orderChange,
});
const lineItems = add_line_items_1.addOrderLineItemsWorkflow.runAsStep({
input: {
order_id: order.id,
items: input.items,
},
});
const lineItemIds = (0, workflows_sdk_1.transform)(lineItems, (lineItems) => {
return lineItems.map((item) => item.id);
});
update_tax_lines_1.updateOrderTaxLinesWorkflow.runAsStep({
input: {
order_id: order.id,
item_ids: lineItemIds,
},
});
const orderChangeActionInput = (0, workflows_sdk_1.transform)({ order, orderChange, orderExchange, items: input.items, lineItems }, ({ order, orderChange, orderExchange, items, lineItems }) => {
return items.map((item, index) => ({
order_change_id: orderChange.id,
order_id: order.id,
exchange_id: orderExchange.id,
version: orderChange.version,
action: utils_1.ChangeActionType.ITEM_ADD,
internal_note: item.internal_note,
reference: "order_exchange",
reference_id: orderExchange.id,
details: {
reference_id: lineItems[index].id,
quantity: item.quantity,
unit_price: item.unit_price ?? lineItems[index].unit_price,
metadata: item.metadata,
},
}));
});
create_order_change_actions_1.createOrderChangeActionsWorkflow.runAsStep({
input: orderChangeActionInput,
});
const refreshArgs = (0, workflows_sdk_1.transform)({ orderChange, orderExchange }, ({ orderChange, orderExchange }) => {
return {
order_change_id: orderChange.id,
exchange_id: orderExchange.id,
order_id: orderExchange.order_id,
};
});
refresh_shipping_1.refreshExchangeShippingWorkflow.runAsStep({
input: refreshArgs,
});
return new workflows_sdk_1.WorkflowResponse((0, preview_order_change_1.previewOrderChangeStep)(orderExchange.order_id));
});
//# sourceMappingURL=exchange-add-new-item.js.map