@medusajs/core-flows
Version:
Set of workflow definitions for Medusa
177 lines • 7.06 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.addOrderLineItemsWorkflow = exports.addOrderLineItemsWorkflowId = void 0;
const utils_1 = require("@medusajs/framework/utils");
const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
const find_one_or_any_region_1 = require("../../cart/steps/find-one-or-any-region");
const find_or_create_customer_1 = require("../../cart/steps/find-or-create-customer");
const find_sales_channel_1 = require("../../cart/steps/find-sales-channel");
const validate_line_item_prices_1 = require("../../cart/steps/validate-line-item-prices");
const validate_variant_prices_1 = require("../../cart/steps/validate-variant-prices");
const prepare_line_item_data_1 = require("../../cart/utils/prepare-line-item-data");
const confirm_variant_inventory_1 = require("../../cart/workflows/confirm-variant-inventory");
const common_1 = require("../../common");
const steps_1 = require("../steps");
const fields_1 = require("../utils/fields");
const schemas_1 = require("../../cart/utils/schemas");
function prepareLineItems(data) {
const items = (data.input.items ?? []).map((item) => {
const variant = data.variants?.find((v) => v.id === item.variant_id);
const input = {
item,
variant: variant,
unitPrice: item.unit_price,
isTaxInclusive: item.is_tax_inclusive ??
variant?.calculated_price?.is_calculated_price_tax_inclusive,
isCustomPrice: (0, utils_1.isDefined)(item?.unit_price),
taxLines: item.tax_lines || [],
adjustments: item.adjustments || [],
};
if (variant && !input.unitPrice) {
input.unitPrice = variant.calculated_price?.calculated_amount;
}
return (0, prepare_line_item_data_1.prepareLineItemData)(input);
});
return items;
}
exports.addOrderLineItemsWorkflowId = "order-add-line-items";
/**
* This workflow adds line items to an order. This is useful when making edits to
* an order. It's used by other workflows, such as {@link orderEditAddNewItemWorkflow}.
*
* You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around adding items to
* an order.
*
* @example
* const { result } = await addOrderLineItemsWorkflow(container)
* .run({
* input: {
* order_id: "order_123",
* items: [
* {
* variant_id: "variant_123",
* quantity: 1,
* }
* ]
* }
* })
*
* @summary
*
* Add line items to an order.
*
* @property hooks.setPricingContext - This hook is executed after the order is retrieved and before the line items are created. You can consume this hook to return any custom context useful for the prices retrieval of the variants to be added to the order.
*
* For example, assuming you have the following custom pricing rule:
*
* ```json
* {
* "attribute": "location_id",
* "operator": "eq",
* "value": "sloc_123",
* }
* ```
*
* You can consume the `setPricingContext` hook to add the `location_id` context to the prices calculation:
*
* ```ts
* import { addOrderLineItemsWorkflow } from "@medusajs/medusa/core-flows";
* import { StepResponse } from "@medusajs/workflows-sdk";
*
* addOrderLineItemsWorkflow.hooks.setPricingContext((
* { order, variantIds, region, customerData, additional_data }, { container }
* ) => {
* return new StepResponse({
* location_id: "sloc_123", // Special price for in-store purchases
* });
* });
* ```
*
* The variants' prices will now be retrieved using the context you return.
*
* :::note
*
* Learn more about prices calculation context in the [Prices Calculation](https://docs.medusajs.com/resources/commerce-modules/pricing/price-calculation) documentation.
*
* :::
*/
exports.addOrderLineItemsWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.addOrderLineItemsWorkflowId, (input) => {
const order = (0, common_1.useRemoteQueryStep)({
entry_point: "orders",
fields: [
"id",
"sales_channel_id",
"region_id",
"customer_id",
"email",
"currency_code",
],
variables: { id: input.order_id },
list: false,
throw_if_key_not_found: true,
}).config({ name: "order-query" });
const variantIds = (0, workflows_sdk_1.transform)({ input }, (data) => {
return (data.input.items ?? [])
.map((item) => item.variant_id)
.filter(Boolean);
});
const [salesChannel, region, customerData] = (0, workflows_sdk_1.parallelize)((0, find_sales_channel_1.findSalesChannelStep)({
salesChannelId: order.sales_channel_id,
}), (0, find_one_or_any_region_1.findOneOrAnyRegionStep)({
regionId: order.region_id,
}), (0, find_or_create_customer_1.findOrCreateCustomerStep)({
customerId: order.customer_id,
email: order.email,
}));
const setPricingContext = (0, workflows_sdk_1.createHook)("setPricingContext", {
order,
variantIds,
region,
customerData,
additional_data: input.additional_data,
}, {
resultValidator: schemas_1.pricingContextResult,
});
const setPricingContextResult = setPricingContext.getResult();
const pricingContext = (0, workflows_sdk_1.transform)({ input, region, customerData, order, setPricingContextResult }, (data) => {
if (!data.region) {
throw new utils_1.MedusaError(utils_1.MedusaError.Types.NOT_FOUND, "Region not found");
}
return {
...(data.setPricingContextResult ? data.setPricingContextResult : {}),
currency_code: data.order.currency_code ?? data.region.currency_code,
region_id: data.region.id,
customer_id: data.customerData.customer?.id,
};
});
const variants = (0, workflows_sdk_1.when)({ variantIds }, ({ variantIds }) => {
return !!variantIds.length;
}).then(() => {
return (0, common_1.useRemoteQueryStep)({
entry_point: "variants",
fields: fields_1.productVariantsFields,
variables: {
id: variantIds,
calculated_price: {
context: pricingContext,
},
},
});
});
(0, validate_variant_prices_1.validateVariantPricesStep)({ variants });
confirm_variant_inventory_1.confirmVariantInventoryWorkflow.runAsStep({
input: {
sales_channel_id: salesChannel.id,
variants,
items: input.items,
},
});
const lineItems = (0, workflows_sdk_1.transform)({ input, variants }, prepareLineItems);
(0, validate_line_item_prices_1.validateLineItemPricesStep)({ items: lineItems });
return new workflows_sdk_1.WorkflowResponse((0, steps_1.createOrderLineItemsStep)({
items: lineItems,
}), {
hooks: [setPricingContext],
});
});
//# sourceMappingURL=add-line-items.js.map