@medusajs/core-flows 3.0.0-preview-20250410210150 → 3.0.0-preview-20251202120138

package/dist/cart/workflows/add-to-cart.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"add-to-cart.d.ts","sourceRoot":"","sources":["../../../src/cart/workflows/add-to-cart.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,yBAAyB,EAE1B,MAAM,2BAA2B,CAAA;AAElC,OAAO,EAML,YAAY,EAEb,MAAM,mCAAmC,CAAA;AA0B1C,eAAO,MAAM,mBAAmB,gBAAgB,CAAA;AAChD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;qCAoK7B,CAAA"}
+{"version":3,"file":"add-to-cart.d.ts","sourceRoot":"","sources":["../../../src/cart/workflows/add-to-cart.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,yBAAyB,EAG1B,MAAM,2BAA2B,CAAA;AAyClC,eAAO,MAAM,mBAAmB,gBAAgB,CAAA;AAChD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;qCA6N7B,CAAA"}

package/dist/cart/workflows/add-to-cart.js

@@ -5,16 +5,17 @@ const utils_1 = require("@medusajs/framework/utils");
 const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
 const common_1 = require("../../common");
 const emit_event_1 = require("../../common/steps/emit-event");
-const use_remote_query_1 = require("../../common/steps/use-remote-query");
+const locking_1 = require("../../locking");
 const steps_1 = require("../steps");
 const validate_cart_1 = require("../steps/validate-cart");
 const validate_line_item_prices_1 = require("../steps/validate-line-item-prices");
-const validate_variant_prices_1 = require("../steps/validate-variant-prices");
 const fields_1 = require("../utils/fields");
+const prepare_confirm_inventory_input_1 = require("../utils/prepare-confirm-inventory-input");
 const prepare_line_item_data_1 = require("../utils/prepare-line-item-data");
+const schemas_1 = require("../utils/schemas");
 const confirm_variant_inventory_1 = require("./confirm-variant-inventory");
+const get_variants_and_items_with_prices_1 = require("./get-variants-and-items-with-prices");
 const refresh_cart_items_1 = require("./refresh-cart-items");
-const schemas_1 = require("../utils/schemas");
 const cartFields = ["completed_at"].concat(fields_1.cartFieldsForPricingContext);
 exports.addToCartWorkflowId = "add-to-cart";
 /**
@@ -83,23 +84,30 @@ exports.addToCartWorkflowId = "add-to-cart";
  *
  * :::
  */
-exports.addToCartWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.addToCartWorkflowId, (input) => {
-    const cartQuery = (0, common_1.useQueryGraphStep)({
+exports.addToCartWorkflow = (0, workflows_sdk_1.createWorkflow)({
+    name: exports.addToCartWorkflowId,
+    idempotent: false,
+}, (input) => {
+    (0, locking_1.acquireLockStep)({
+        key: input.cart_id,
+        timeout: 2,
+        ttl: 10,
+    });
+    const { data: cart } = (0, common_1.useQueryGraphStep)({
         entity: "cart",
         filters: { id: input.cart_id },
         fields: cartFields,
-        options: { throwIfKeyNotFound: true },
+        options: { throwIfKeyNotFound: true, isList: false },
     }).config({ name: "get-cart" });
-    const cart = (0, workflows_sdk_1.transform)({ cartQuery }, ({ cartQuery }) => {
-        return cartQuery.data[0];
-    });
     (0, validate_cart_1.validateCartStep)({ cart });
     const validate = (0, workflows_sdk_1.createHook)("validate", {
         input,
         cart,
     });
     const variantIds = (0, workflows_sdk_1.transform)({ input }, (data) => {
-        return (data.input.items ?? []).map((i) => i.variant_id).filter(Boolean);
+        return (data.input.items ?? [])
+            .map((i) => i.variant_id)
+            .filter((v) => !!v);
     });
     const setPricingContext = (0, workflows_sdk_1.createHook)("setPricingContext", {
         cart,
@@ -110,39 +118,63 @@ exports.addToCartWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.addToCar
         resultValidator: schemas_1.pricingContextResult,
     });
     const setPricingContextResult = setPricingContext.getResult();
-    const pricingContext = (0, workflows_sdk_1.transform)({ cart, setPricingContextResult }, (data) => {
-        return {
-            ...data.cart,
-            ...(data.setPricingContextResult ? data.setPricingContextResult : {}),
-            currency_code: data.cart.currency_code,
-            region_id: data.cart.region_id,
-            region: data.cart.region,
-            customer_id: data.cart.customer_id,
-            customer: data.cart.customer,
-        };
-    });
-    const variants = (0, workflows_sdk_1.when)({ variantIds }, ({ variantIds }) => {
+    const { variants: variantsData, lineItems: lineItemsData } = (0, workflows_sdk_1.when)("should-calculate-prices", { variantIds }, ({ variantIds }) => {
         return !!variantIds.length;
     }).then(() => {
-        return (0, use_remote_query_1.useRemoteQueryStep)({
-            entry_point: "variants",
-            fields: fields_1.productVariantsFields,
-            variables: {
-                id: variantIds,
-                calculated_price: {
-                    context: pricingContext,
+        const { variants: variantsData, lineItems: items } = get_variants_and_items_with_prices_1.getVariantsAndItemsWithPrices.runAsStep({
+            input: {
+                cart,
+                items: input.items,
+                setPricingContextResult: setPricingContextResult,
+                variants: {
+                    id: variantIds,
+                    fields: (0, utils_1.deduplicate)([
+                        ...fields_1.productVariantsFields,
+                        ...prepare_confirm_inventory_input_1.requiredVariantFieldsForInventoryConfirmation,
+                    ]),
                 },
             },
         });
+        const lineItems = (0, workflows_sdk_1.transform)({ items }, ({ items }) => {
+            return items.map((item) => {
+                return item.data;
+            });
+        });
+        return { variants: variantsData, lineItems };
+    });
+    const fetchedVariants = (0, workflows_sdk_1.when)("fetch-variants", { variantsData, variantIds }, ({ variantsData, variantIds }) => {
+        return !variantsData?.length && !!variantIds.length;
+    }).then(() => {
+        return (0, common_1.useQueryGraphStep)({
+            entity: "variants",
+            fields: (0, utils_1.deduplicate)([
+                ...fields_1.productVariantsFields,
+                ...prepare_confirm_inventory_input_1.requiredVariantFieldsForInventoryConfirmation,
+            ]),
+            filters: {
+                id: variantIds,
+            },
+            options: {
+                cache: {
+                    enable: true,
+                },
+            },
+        }).config({ name: "fetch-variants" });
+    });
+    const variants = (0, workflows_sdk_1.transform)({ variantsData, fetchedVariants }, ({ variantsData, fetchedVariants }) => {
+        return (variantsData ??
+            fetchedVariants);
     });
-    (0, validate_variant_prices_1.validateVariantPricesStep)({ variants });
-    const lineItems = (0, workflows_sdk_1.transform)({ input, variants }, (data) => {
-        const items = (data.input.items ?? []).map((item) => {
-            const variant = (data.variants ?? []).find((v) => v.id === item.variant_id);
+    const lineItems = (0, workflows_sdk_1.transform)({ cart_id: input.cart_id, items: input.items, lineItemsData, variants }, ({ cart_id, items: items_, lineItemsData, variants }) => {
+        if (lineItemsData?.length) {
+            return lineItemsData;
+        }
+        const items = (items_ ?? []).map((item) => {
+            const variant = (variants ?? []).find((v) => v.id === item.variant_id);
             const input = {
                 item,
                 variant: variant,
-                cartId: data.input.cart_id,
+                cartId: cart_id,
                 unitPrice: item.unit_price,
                 isTaxInclusive: item.is_tax_inclusive ??
                     variant?.calculated_price?.is_calculated_price_tax_inclusive,
@@ -168,7 +200,7 @@ exports.addToCartWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.addToCar
     confirm_variant_inventory_1.confirmVariantInventoryWorkflow.runAsStep({
         input: {
             sales_channel_id: cart.sales_channel_id,
-            variants,
+            variants: variants,
             items: input.items,
             itemsToUpdate: itemsToConfirmInventory,
         },
@@ -184,12 +216,18 @@ exports.addToCartWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.addToCar
         return createdLineItems.concat(updatedLineItems);
     });
     refresh_cart_items_1.refreshCartItemsWorkflow.runAsStep({
-        input: { cart_id: cart.id, items: allItems },
+        input: {
+            cart_id: cart.id,
+            items: allItems,
+            additional_data: input.additional_data,
+        },
     });
-    (0, emit_event_1.emitEventStep)({
+    (0, workflows_sdk_1.parallelize)((0, emit_event_1.emitEventStep)({
         eventName: utils_1.CartWorkflowEvents.UPDATED,
         data: { id: cart.id },
-    });
+    }), (0, locking_1.releaseLockStep)({
+        key: cart.id,
+    }));
     return new workflows_sdk_1.WorkflowResponse(void 0, {
         hooks: [validate, setPricingContext],
     });

package/dist/cart/workflows/add-to-cart.js.map

@@ -1 +1 @@
-{"version":3,"file":"add-to-cart.js","sourceRoot":"","sources":["../../../src/cart/workflows/add-to-cart.ts"],"names":[],"mappings":";;;AAKA,qDAAyE;AACzE,qEAQ0C;AAC1C,yCAAgD;AAChD,8DAA6D;AAC7D,0EAAwE;AACxE,oCAIiB;AACjB,0DAAyD;AACzD,kFAA+E;AAC/E,8EAA4E;AAC5E,4CAGwB;AACxB,4EAGwC;AACxC,2EAA6E;AAC7E,6DAA+D;AAC/D,8CAAuD;AAEvD,MAAM,UAAU,GAAG,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,oCAA2B,CAAC,CAAA;AAE1D,QAAA,mBAAmB,GAAG,aAAa,CAAA;AAChD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AACU,QAAA,iBAAiB,GAAG,IAAA,8BAAc,EAC7C,2BAAmB,EACnB,CAAC,KAA+D,EAAE,EAAE;IAClE,MAAM,SAAS,GAAG,IAAA,0BAAiB,EAAC;QAClC,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,OAAO,EAAE;QAC9B,MAAM,EAAE,UAAU;QAClB,OAAO,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE;KACtC,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAA;IAE/B,MAAM,IAAI,GAAG,IAAA,yBAAS,EAAC,EAAE,SAAS,EAAE,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE;QACtD,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IAC1B,CAAC,CAAC,CAAA;IAEF,IAAA,gCAAgB,EAAC,EAAE,IAAI,EAAE,CAAC,CAAA;IAC1B,MAAM,QAAQ,GAAG,IAAA,0BAAU,EAAC,UAAU,EAAE;QACtC,KAAK;QACL,IAAI;KACL,CAAC,CAAA;IAEF,MAAM,UAAU,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;QAC/C,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAC1E,CAAC,CAAC,CAAA;IAEF,MAAM,iBAAiB,GAAG,IAAA,0BAAU,EAClC,mBAAmB,EACnB;QACE,IAAI;QACJ,UAAU;QACV,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,eAAe,EAAE,KAAK,CAAC,eAAe;KACvC,EACD;QACE,eAAe,EAAE,8BAAoB;KACtC,CACF,CAAA;IAED,MAAM,uBAAuB,GAAG,iBAAiB,CAAC,SAAS,EAAE,CAAA;IAC7D,MAAM,cAAc,GAAG,IAAA,yBAAS,EAC9B,EAAE,IAAI,EAAE,uBAAuB,EAAE,EACjC,CAAC,IAAI,EAAE,EAAE;QACP,OAAO;YACL,GAAG,IAAI,CAAC,IAAI;YACZ,GAAG,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC,EAAE,CAAC;YACrE,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC,aAAa;YACtC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS;YAC9B,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM;YACxB,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW;YAClC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ;SAC7B,CAAA;IACH,CAAC,CACF,CAAA;IAED,MAAM,QAAQ,GAAG,IAAA,oBAAI,EAAC,EAAE,UAAU,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE;QACvD,OAAO,CAAC,CAAC,UAAU,CAAC,MAAM,CAAA;IAC5B,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;QACX,OAAO,IAAA,qCAAkB,EAAC;YACxB,WAAW,EAAE,UAAU;YACvB,MAAM,EAAE,8BAAqB;YAC7B,SAAS,EAAE;gBACT,EAAE,EAAE,UAAU;gBACd,gBAAgB,EAAE;oBAChB,OAAO,EAAE,cAAc;iBACxB;aACF;SACF,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAA,mDAAyB,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAA;IAEvC,MAAM,SAAS,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;QACxD,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YAClD,MAAM,OAAO,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,IAAI,CACxC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,CAAC,UAAU,CAC/B,CAAA;YAEF,MAAM,KAAK,GAA6B;gBACtC,IAAI;gBACJ,OAAO,EAAE,OAAO;gBAChB,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO;gBAC1B,SAAS,EAAE,IAAI,CAAC,UAAU;gBAC1B,cAAc,EACZ,IAAI,CAAC,gBAAgB;oBACrB,OAAO,EAAE,gBAAgB,EAAE,iCAAiC;gBAC9D,aAAa,EAAE,IAAA,iBAAS,EAAC,IAAI,EAAE,UAAU,CAAC;aAC3C,CAAA;YAED,IAAI,OAAO,IAAI,CAAC,IAAA,iBAAS,EAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC3C,KAAK,CAAC,SAAS,GAAG,OAAO,CAAC,gBAAgB,EAAE,iBAAiB,CAAA;YAC/D,CAAC;YAED,OAAO,IAAA,4CAAmB,EAAC,KAAK,CAAC,CAAA;QACnC,CAAC,CAAC,CAAA;QAEF,OAAO,KAAK,CAAA;IACd,CAAC,CAAC,CAAA;IAEF,IAAA,sDAA0B,EAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAA;IAEhD,MAAM,EAAE,aAAa,GAAG,EAAE,EAAE,aAAa,GAAG,EAAE,EAAE,GAAG,IAAA,8BAAsB,EAAC;QACxE,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,KAAK,EAAE,SAAS;KACjB,CAAC,CAAA;IAEF,MAAM,uBAAuB,GAAG,IAAA,yBAAS,EACvC,EAAE,aAAa,EAAE,aAAa,EAAE,EAChC,CAAC,IAAI,EAAE,EAAE;QACP,OAAQ,IAAI,CAAC,aAAoB;aAC9B,MAAM,CAAC,IAAI,CAAC,aAAmB,CAAC;aAChC,MAAM,CACL,CACE,IAI2B,EAC3B,EAAE,CACF,IAAA,iBAAS,EACP,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CACzD,CACmE,CAAA;IAC5E,CAAC,CACF,CAAA;IAED,2DAA+B,CAAC,SAAS,CAAC;QACxC,KAAK,EAAE;YACL,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;YACvC,QAAQ;YACR,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,aAAa,EAAE,uBAAuB;SACvC;KACF,CAAC,CAAA;IAEF,MAAM,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,GAAG,IAAA,2BAAW,EACtD,IAAA,2BAAmB,EAAC;QAClB,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,KAAK,EAAE,aAAa;KACrB,CAAC,EACF,IAAA,2BAAmB,EAAC;QAClB,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,KAAK,EAAE,aAAa;KACrB,CAAC,CACH,CAAA;IAED,MAAM,QAAQ,GAAG,IAAA,yBAAS,EACxB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,EACtC,CAAC,EAAE,gBAAgB,GAAG,EAAE,EAAE,gBAAgB,GAAG,EAAE,EAAE,EAAE,EAAE;QACnD,OAAO,gBAAgB,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAA;IAClD,CAAC,CACF,CAAA;IAED,6CAAwB,CAAC,SAAS,CAAC;QACjC,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE;KAC7C,CAAC,CAAA;IAEF,IAAA,0BAAa,EAAC;QACZ,SAAS,EAAE,0BAAkB,CAAC,OAAO;QACrC,IAAI,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE;KACtB,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,KAAK,CAAC,EAAE;QAClC,KAAK,EAAE,CAAC,QAAQ,EAAE,iBAAiB,CAAU;KAC9C,CAAC,CAAA;AACJ,CAAC,CACF,CAAA"}
+{"version":3,"file":"add-to-cart.js","sourceRoot":"","sources":["../../../src/cart/workflows/add-to-cart.ts"],"names":[],"mappings":";;;AAMA,qDAIkC;AAClC,qEAO0C;AAC1C,yCAAgD;AAChD,8DAA6D;AAC7D,2CAAgE;AAChE,oCAIiB;AACjB,0DAAyD;AACzD,kFAA+E;AAC/E,4CAGwB;AACxB,8FAAwG;AACxG,4EAIwC;AACxC,8CAAuD;AACvD,2EAA6E;AAC7E,6FAAoF;AACpF,6DAA+D;AAE/D,MAAM,UAAU,GAAG,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,oCAA2B,CAAC,CAAA;AAE1D,QAAA,mBAAmB,GAAG,aAAa,CAAA;AAChD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AACU,QAAA,iBAAiB,GAAG,IAAA,8BAAc,EAC7C;IACE,IAAI,EAAE,2BAAmB;IACzB,UAAU,EAAE,KAAK;CAClB,EACD,CAAC,KAAiD,EAAE,EAAE;IACpD,IAAA,yBAAe,EAAC;QACd,GAAG,EAAE,KAAK,CAAC,OAAO;QAClB,OAAO,EAAE,CAAC;QACV,GAAG,EAAE,EAAE;KACR,CAAC,CAAA;IAEF,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAA,0BAAiB,EAAC;QACvC,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,OAAO,EAAE;QAC9B,MAAM,EAAE,UAAU;QAClB,OAAO,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE;KACrD,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAA;IAE/B,IAAA,gCAAgB,EAAC,EAAE,IAAI,EAAE,CAAC,CAAA;IAC1B,MAAM,QAAQ,GAAG,IAAA,0BAAU,EAAC,UAAU,EAAE;QACtC,KAAK;QACL,IAAI;KACL,CAAC,CAAA;IAEF,MAAM,UAAU,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,EAAY,EAAE;QACzD,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC;aAC5B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC;aACxB,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACpC,CAAC,CAAC,CAAA;IAEF,MAAM,iBAAiB,GAAG,IAAA,0BAAU,EAClC,mBAAmB,EACnB;QACE,IAAI;QACJ,UAAU;QACV,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,eAAe,EAAE,KAAK,CAAC,eAAe;KACvC,EACD;QACE,eAAe,EAAE,8BAAoB;KACtC,CACF,CAAA;IAED,MAAM,uBAAuB,GAAG,iBAAiB,CAAC,SAAS,EAAE,CAAA;IAE7D,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,aAAa,EAAE,GAAG,IAAA,oBAAI,EAC/D,yBAAyB,EACzB,EAAE,UAAU,EAAE,EACd,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE;QACjB,OAAO,CAAC,CAAC,UAAU,CAAC,MAAM,CAAA;IAC5B,CAAC,CACF,CAAC,IAAI,CAAC,GAAG,EAAE;QACV,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,KAAK,EAAE,GAChD,kEAA6B,CAAC,SAAS,CAAC;YACtC,KAAK,EAAE;gBACL,IAAI;gBACJ,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,uBAAuB,EAAE,uBAAwB;gBACjD,QAAQ,EAAE;oBACR,EAAE,EAAE,UAAU;oBACd,MAAM,EAAE,IAAA,mBAAW,EAAC;wBAClB,GAAG,8BAAqB;wBACxB,GAAG,+EAA6C;qBACjD,CAAC;iBACH;aACF;SACF,CAAC,CAAA;QAEJ,MAAM,SAAS,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;YACnD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;gBACxB,OAAO,IAAI,CAAC,IAAgC,CAAA;YAC9C,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,CAAA;IAC9C,CAAC,CAAC,CAAA;IAEF,MAAM,eAAe,GAAG,IAAA,oBAAI,EAC1B,gBAAgB,EAChB,EAAE,YAAY,EAAE,UAAU,EAAE,EAC5B,CAAC,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE;QAC/B,OAAO,CAAC,YAAY,EAAE,MAAM,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,CAAA;IACrD,CAAC,CACF,CAAC,IAAI,CAAC,GAAG,EAAE;QACV,OAAO,IAAA,0BAAiB,EAAC;YACvB,MAAM,EAAE,UAAU;YAClB,MAAM,EAAE,IAAA,mBAAW,EAAC;gBAClB,GAAG,8BAAqB;gBACxB,GAAG,+EAA6C;aACjD,CAAC;YACF,OAAO,EAAE;gBACP,EAAE,EAAE,UAAU;aACf;YACD,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,IAAI;iBACb;aACF;SACF,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC,CAAA;IACvC,CAAC,CAAC,CAAA;IAEF,MAAM,QAAQ,GAAG,IAAA,yBAAS,EACxB,EAAE,YAAY,EAAE,eAAe,EAAE,EACjC,CAAC,EAAE,YAAY,EAAE,eAAe,EAAE,EAAE,EAAE;QACpC,OAAO,CAAC,YAAY;YAClB,eAAe,CAA6C,CAAA;IAChE,CAAC,CACF,CAAA;IAED,MAAM,SAAS,GAAG,IAAA,yBAAS,EACzB,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,EACvE,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,EAAE;QACtD,IAAI,aAAa,EAAE,MAAM,EAAE,CAAC;YAC1B,OAAO,aAAa,CAAA;QACtB,CAAC;QAED,MAAM,KAAK,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACxC,MAAM,OAAO,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,IAAI,CACnC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,CAAC,UAAU,CAC/B,CAAA;YAEF,MAAM,KAAK,GAA6B;gBACtC,IAAI;gBACJ,OAAO,EAAE,OAAO;gBAChB,MAAM,EAAE,OAAO;gBACf,SAAS,EAAE,IAAI,CAAC,UAAU;gBAC1B,cAAc,EACZ,IAAI,CAAC,gBAAgB;oBACrB,OAAO,EAAE,gBAAgB,EAAE,iCAAiC;gBAC9D,aAAa,EAAE,IAAA,iBAAS,EAAC,IAAI,EAAE,UAAU,CAAC;aAC3C,CAAA;YAED,IAAI,OAAO,IAAI,CAAC,IAAA,iBAAS,EAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC3C,KAAK,CAAC,SAAS,GAAG,OAAO,CAAC,gBAAgB,EAAE,iBAAiB,CAAA;YAC/D,CAAC;YAED,OAAO,IAAA,4CAAmB,EAAC,KAAK,CAAC,CAAA;QACnC,CAAC,CAAC,CAAA;QAEF,OAAO,KAAK,CAAA;IACd,CAAC,CACF,CAAA;IAED,IAAA,sDAA0B,EAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAA;IAEhD,MAAM,EAAE,aAAa,GAAG,EAAE,EAAE,aAAa,GAAG,EAAE,EAAE,GAAG,IAAA,8BAAsB,EAAC;QACxE,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,KAAK,EAAE,SAAS;KACjB,CAAC,CAAA;IAEF,MAAM,uBAAuB,GAAG,IAAA,yBAAS,EACvC,EAAE,aAAa,EAAE,aAAa,EAAE,EAChC,CAAC,IAAI,EAAE,EAAE;QACP,OAAQ,IAAI,CAAC,aAAoB;aAC9B,MAAM,CAAC,IAAI,CAAC,aAAmB,CAAC;aAChC,MAAM,CACL,CACE,IAI2B,EAC3B,EAAE,CACF,IAAA,iBAAS,EACP,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CACzD,CACmE,CAAA;IAC5E,CAAC,CACF,CAAA;IAED,2DAA+B,CAAC,SAAS,CAAC;QACxC,KAAK,EAAE;YACL,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;YACvC,QAAQ,EACN,QAA0E;YAC5E,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,aAAa,EAAE,uBAAuB;SACvC;KACF,CAAC,CAAA;IAEF,MAAM,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,GAAG,IAAA,2BAAW,EACtD,IAAA,2BAAmB,EAAC;QAClB,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,KAAK,EAAE,aAAa;KACrB,CAAC,EACF,IAAA,2BAAmB,EAAC;QAClB,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,KAAK,EAAE,aAAa;KACrB,CAAC,CACH,CAAA;IAED,MAAM,QAAQ,GAAG,IAAA,yBAAS,EACxB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,EACtC,CAAC,EAAE,gBAAgB,GAAG,EAAE,EAAE,gBAAgB,GAAG,EAAE,EAAE,EAAE,EAAE;QACnD,OAAO,gBAAgB,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAA;IAClD,CAAC,CACF,CAAA;IAED,6CAAwB,CAAC,SAAS,CAAC;QACjC,KAAK,EAAE;YACL,OAAO,EAAE,IAAI,CAAC,EAAE;YAChB,KAAK,EAAE,QAAQ;YACf,eAAe,EAAE,KAAK,CAAC,eAAe;SACvC;KACF,CAAC,CAAA;IAEF,IAAA,2BAAW,EACT,IAAA,0BAAa,EAAC;QACZ,SAAS,EAAE,0BAAkB,CAAC,OAAO;QACrC,IAAI,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE;KACtB,CAAC,EACF,IAAA,yBAAe,EAAC;QACd,GAAG,EAAE,IAAI,CAAC,EAAE;KACb,CAAC,CACH,CAAA;IAED,OAAO,IAAI,gCAAgB,CAAC,KAAK,CAAC,EAAE;QAClC,KAAK,EAAE,CAAC,QAAQ,EAAE,iBAAiB,CAAU;KAC9C,CAAC,CAAA;AACJ,CAAC,CACF,CAAA"}

package/dist/cart/workflows/complete-cart.d.ts

@@ -14,7 +14,6 @@ export type CompleteCartWorkflowOutput = {
      */
     id: string;
 };
-export declare const THREE_DAYS: number;
 export declare const completeCartWorkflowId = "complete-cart";
 /**
  * This workflow completes a cart and places an order for the customer. It's executed by the
@@ -24,6 +23,214 @@ export declare const completeCartWorkflowId = "complete-cart";
  * For example, in the [Subscriptions recipe](https://docs.medusajs.com/resources/recipes/subscriptions/examples/standard#create-workflow),
  * this workflow is used within another workflow that creates a subscription order.
  *
+ * ## Cart Completion Idempotency
+ *
+ * This workflow's logic is idempotent, meaning that if it is executed multiple times with the same input, it will not create duplicate orders. The
+ * same order will be returned for subsequent executions with the same cart ID. This is necessary to avoid rolling back payments or causing
+ * other side effects if the workflow is retried or fails due to transient errors.
+ *
+ * So, if you use this workflow within your own, make sure your workflow's steps are idempotent as well to avoid unintended side effects.
+ * Your workflow must also acquire and release locks around this workflow to prevent concurrent executions for the same cart.
+ *
+ * The following sections cover some common scenarios and how to handle them.
+ *
+ * ### Creating Links and Linked Records
+ *
+ * In some cases, you might want to create custom links or linked records to the order. For example, you might want to create a link from the order to a
+ * digital order.
+ *
+ * In such cases, ensure that your workflow's logic checks for existing links or records before creating new ones. You can query the
+ * [entry point of the link](https://docs.medusajs.com/learn/fundamentals/module-links/custom-columns#method-2-using-entry-point)
+ * to check for existing links before creating new ones.
+ *
+ * For example:
+ *
+ * ```ts
+ * import {
+ *   createWorkflow,
+ *   when,
+ *   WorkflowResponse
+ * } from "@medusajs/framework/workflows-sdk"
+ * import {
+ *   useQueryGraphStep,
+ *   completeCartWorkflow,
+ *   acquireLockStep,
+ *   releaseLockStep
+ * } from "@medusajs/framework/workflows-sdk"
+ * import digitalProductOrderOrderLink from "../../links/digital-product-order"
+ *
+ * type WorkflowInput = {
+ *   cart_id: string
+ * }
+ *
+ * const createDigitalProductOrderWorkflow = createWorkflow(
+ *   "create-digital-product-order",
+ *   (input: WorkflowInput) => {
+ *     acquireLockStep({
+ *       key: input.cart_id,
+ *       timeout: 30,
+ *       ttl: 120,
+ *     });
+ *     const { id } = completeCartWorkflow.runAsStep({
+ *       input: {
+ *         id: input.cart_id
+ *       }
+ *     })
+ *
+ *     const { data: existingLinks } = useQueryGraphStep({
+ *       entity: digitalProductOrderOrderLink.entryPoint,
+ *       fields: ["digital_product_order.id"],
+ *       filters: { order_id: id },
+ *     }).config({ name: "retrieve-existing-links" });
+ *
+ *
+ *     const digital_product_order = when(
+ *       "create-digital-product-order-condition",
+ *       { existingLinks },
+ *       (data) => {
+ *         return (
+ *           data.existingLinks.length === 0
+ *         );
+ *       }
+ *     )
+ *     .then(() => {
+ *       // create digital product order logic...
+ *     })
+ *
+ *     // other workflow logic...
+ *
+ *     releaseLockStep({
+ *       key: input.cart_id,
+ *     })
+ *
+ *     return new WorkflowResponse({
+ *       // workflow output...
+ *     })
+ *   }
+ * )
+ * ```
+ *
+ * ### Custom Validation with Conflicts
+ *
+ * Some use cases require custom validation that may cause conflicts on subsequent executions of the workflow.
+ * For example, if you're selling tickets to an event, you might want to validate that the tickets are available
+ * on selected dates.
+ *
+ * In this scenario, if the workflow is retried after the first execution, the validation
+ * will fail since the tickets would have already been reserved in the first execution. This makes the cart
+ * completion non-idempotent.
+ *
+ * To handle these cases, you can create a step that throws an error if the validation fails. Then, in the compensation function,
+ * you can cancel the order if the validation fails. For example:
+ *
+ * ```ts
+ * import { createStep, StepResponse } from "@medusajs/framework/workflows-sdk"
+ * import { MedusaError } from "@medusajs/framework/utils"
+ * import { cancelOrderWorkflow } from "@medusajs/medusa/core-flows"
+ *
+ * type StepInput = {
+ *   order_id: string
+ *   // other input fields...
+ * }
+ *
+ * export const customCartValidationStep = createStep(
+ *   "custom-cart-validation",
+ *   async (input, { container }) => {
+ *     const isValid = true // replace with actual validation logic
+ *
+ *     if (!isValid) {
+ *       throw new MedusaError(
+ *         MedusaError.Types.INVALID_DATA,
+ *         "Custom cart validation failed"
+ *       )
+ *     }
+ *
+ *     return new StepResponse(void 0, input.order_id)
+ *   },
+ *   async (order_id, { container, context }) => {
+ *     if (!order_id) return
+ *
+ *     cancelOrderWorkflow(container).run({
+ *       input: {
+ *         id: order_id,
+ *       },
+ *       context,
+ *       container
+ *     })
+ *   }
+ * )
+ * ```
+ *
+ * Then, in your custom workflow, only run the validation step if the order is being created for the first time. For example,
+ * only run the validation if the link from the order to your custom data does not exist yet:
+ *
+ * ```ts
+ * import {
+ *   createWorkflow,
+ *   when,
+ *   WorkflowResponse
+ * } from "@medusajs/framework/workflows-sdk"
+ * import { useQueryGraphStep } from "@medusajs/framework/workflows-sdk"
+ * import ticketOrderLink from "../../links/ticket-order"
+ *
+ * type WorkflowInput = {
+ *   cart_id: string
+ * }
+ *
+ * const createTicketOrderWorkflow = createWorkflow(
+ *   "create-ticket-order",
+ *   (input: WorkflowInput) => {
+ *     acquireLockStep({
+ *       key: input.cart_id,
+ *       timeout: 30,
+ *       ttl: 120,
+ *     });
+ *     const { id } = completeCartWorkflow.runAsStep({
+ *       input: {
+ *         id: input.cart_id
+ *       }
+ *     })
+ *
+ *     const { data: existingLinks } = useQueryGraphStep({
+ *       entity: ticketOrderLink.entryPoint,
+ *       fields: ["ticket.id"],
+ *       filters: { order_id: id },
+ *     }).config({ name: "retrieve-existing-links" });
+ *
+ *
+ *     const ticket_order = when(
+ *       "create-ticket-order-condition",
+ *       { existingLinks },
+ *       (data) => {
+ *         return (
+ *           data.existingLinks.length === 0
+ *         );
+ *       }
+ *     )
+ *     .then(() => {
+ *       customCartValidationStep({ order_id: id })
+ *       // create ticket order logic...
+ *     })
+ *
+ *     // other workflow logic...
+ *
+ *     releaseLockStep({
+ *       key: input.cart_id,
+ *     })
+ *
+ *     return new WorkflowResponse({
+ *       // workflow output...
+ *     })
+ *   }
+ * )
+ * ```
+ *
+ * The first time this workflow is executed for a cart, the validation step will run and validate the cart. If the validation fails,
+ * the order will be canceled in the compensation function.
+ *
+ * If the validation is successful and the workflow is retried, the validation step will be skipped since the link from the order to the
+ * ticket order already exists. This ensures that the workflow remains idempotent.
+ *
  * @example
  * const { result } = await completeCartWorkflow(container)
  * .run({

package/dist/cart/workflows/complete-cart.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"complete-cart.d.ts","sourceRoot":"","sources":["../../../src/cart/workflows/complete-cart.ts"],"names":[],"mappings":"AAWA,OAAO,EAML,YAAY,EAEb,MAAM,mCAAmC,CAAA;AAyB1C;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAED,eAAO,MAAM,UAAU,QAAmB,CAAA;AAE1C,eAAO,MAAM,sBAAsB,kBAAkB,CAAA;AACrD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,oBAAoB;;;aAwShC,CAAA"}
+{"version":3,"file":"complete-cart.d.ts","sourceRoot":"","sources":["../../../src/cart/workflows/complete-cart.ts"],"names":[],"mappings":"AAaA,OAAO,EAML,YAAY,EAEb,MAAM,mCAAmC,CAAA;AA2B1C;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAMD,eAAO,MAAM,sBAAsB,kBAAkB,CAAA;AACrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqOG;AACH,eAAO,MAAM,oBAAoB;;;aA2WhC,CAAA"}