@medusajs/core-flows
Version:
Set of workflow definitions for Medusa
197 lines • 8.13 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.createClaimShippingMethodWorkflow = exports.createClaimShippingMethodWorkflowId = exports.createClaimShippingMethodValidationStep = 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 create_order_shipping_methods_1 = require("../../steps/create-order-shipping-methods");
const order_validation_1 = require("../../utils/order-validation");
const prepare_shipping_method_1 = require("../../utils/prepare-shipping-method");
const create_order_change_actions_1 = require("../create-order-change-actions");
const update_tax_lines_1 = require("../update-tax-lines");
const fetch_shipping_option_1 = require("../fetch-shipping-option");
/**
* This step confirms that a shipping method can be created for a claim.
* If the order or claim is canceled, or the order change is not active, 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 = createClaimShippingMethodValidationStep({
* order: {
* id: "order_123",
* // other order details...
* },
* orderChange: {
* id: "orch_123",
* // other order change details...
* },
* orderClaim: {
* id: "claim_123",
* // other order claim details...
* },
* })
*/
exports.createClaimShippingMethodValidationStep = (0, workflows_sdk_1.createStep)("validate-create-claim-shipping-method", async function ({ order, orderChange, orderClaim, }) {
(0, order_validation_1.throwIfIsCancelled)(order, "Order");
(0, order_validation_1.throwIfIsCancelled)(orderClaim, "Claim");
(0, order_validation_1.throwIfOrderChangeIsNotActive)({ orderChange });
});
exports.createClaimShippingMethodWorkflowId = "create-claim-shipping-method";
/**
* This workflow creates an inbound (return) or outbound (delivering new items) shipping method for a claim.
* It's used by the [Add Inbound Shipping Admin API Route](https://docs.medusajs.com/api/admin#claims_postclaimsidinboundshippingmethod),
* and the [Add Outbound Shipping Admin API Route](https://docs.medusajs.com/api/admin#claims_postclaimsidoutboundshippingmethod).
*
* You can use this workflow within your customizations or your own custom workflows, allowing you to create a shipping method
* for a claim in your custom flows.
*
* @example
* To create an outbound shipping method for a claim:
*
* ```ts
* const { result } = await createClaimShippingMethodWorkflow(container)
* .run({
* input: {
* claim_id: "claim_123",
* shipping_option_id: "so_123",
* }
* })
* ```
*
* To create an inbound shipping method for a claim, specify the ID of the return associated with the claim:
*
* ```ts
* const { result } = await createClaimShippingMethodWorkflow(container)
* .run({
* input: {
* claim_id: "claim_123",
* return_id: "return_123",
* shipping_option_id: "so_123",
* }
* })
* ```
*
* @summary
*
* Create an inbound or outbound shipping method for a claim.
*/
exports.createClaimShippingMethodWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.createClaimShippingMethodWorkflowId, 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", "region_id", "currency_code", "canceled_at"],
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" });
const isReturn = (0, workflows_sdk_1.transform)(input, (data) => {
return !!data.return_id;
});
const fetchShippingOptionInput = (0, workflows_sdk_1.transform)({ input, isReturn, orderChange, order }, (data) => {
const changeActionType = data.isReturn
? utils_1.ChangeActionType.RETURN_ITEM
: utils_1.ChangeActionType.ITEM_ADD;
const items = data.orderChange.actions
.filter((action) => action.action === changeActionType)
.map((a) => ({
id: a.details?.reference_id,
quantity: a.details?.quantity,
}));
const context = data.isReturn
? {
return_id: data.input.return_id,
return_items: items,
}
: {
claim_id: data.input.claim_id,
claim_items: items,
};
return {
order_id: data.order.id,
currency_code: data.order.currency_code,
shipping_option_id: data.input.shipping_option_id,
custom_amount: data.input.custom_amount,
context: context,
};
});
const shippingOption = fetch_shipping_option_1.fetchShippingOptionForOrderWorkflow.runAsStep({
input: fetchShippingOptionInput,
});
const shippingOptions = (0, workflows_sdk_1.transform)(shippingOption, (shippingOption) => {
return [shippingOption];
});
(0, exports.createClaimShippingMethodValidationStep)({ order, orderClaim, orderChange });
const shippingMethodInput = (0, workflows_sdk_1.transform)({
relatedEntity: orderClaim,
shippingOptions,
customPrice: input.custom_amount,
orderChange,
input,
}, (0, prepare_shipping_method_1.prepareShippingMethod)("claim_id"));
const createdMethods = (0, create_order_shipping_methods_1.createOrderShippingMethods)({
shipping_methods: [shippingMethodInput],
});
const shippingMethodIds = (0, workflows_sdk_1.transform)(createdMethods, (createdMethods) => {
return createdMethods.map((item) => item.id);
});
update_tax_lines_1.updateOrderTaxLinesWorkflow.runAsStep({
input: {
order_id: order.id,
shipping_method_ids: shippingMethodIds,
is_return: isReturn,
},
});
const orderChangeActionInput = (0, workflows_sdk_1.transform)({
order,
orderClaim,
shippingOptions,
createdMethods,
customPrice: input.custom_amount,
orderChange,
input,
}, ({ shippingOptions, orderClaim, order, createdMethods, customPrice, orderChange, input, }) => {
const shippingOption = shippingOptions[0];
const createdMethod = createdMethods[0];
const methodPrice = customPrice ?? shippingOption.calculated_price.calculated_amount;
return {
action: utils_1.ChangeActionType.SHIPPING_ADD,
reference: "order_shipping_method",
order_change_id: orderChange.id,
reference_id: createdMethod.id,
amount: methodPrice,
order_id: order.id,
return_id: input.return_id,
claim_id: orderClaim.id,
};
});
create_order_change_actions_1.createOrderChangeActionsWorkflow.runAsStep({
input: [orderChangeActionInput],
});
return new workflows_sdk_1.WorkflowResponse((0, steps_1.previewOrderChangeStep)(order.id));
});
//# sourceMappingURL=create-claim-shipping-method.js.map