@medusajs/core-flows 2.8.3-preview-20250521180140 → 2.8.3-preview-20250522000308

package/dist/cart/workflows/create-cart-credit-lines.d.ts

@@ -1,4 +1,21 @@
-import { CartCreditLineDTO, CreateCartCreditLineDTO } from "@medusajs/framework/types";
+import { CartCreditLineDTO, CreateCartCreditLinesWorkflowInput } from "@medusajs/framework/types";
 export declare const createCartCreditLinesWorkflowId = "create-cart-credit-lines";
-export declare const createCartCreditLinesWorkflow: import("@medusajs/framework/workflows-sdk").ReturnWorkflow<CreateCartCreditLineDTO[], CartCreditLineDTO[], []>;
+/**
+ * This workflow creates one or more credit lines for a cart.
+ *
+ * @example
+ * const { result } = await createCartCreditLinesWorkflow(container)
+ * .run({
+ *   input: {
+ *     cart_id: "cart_123",
+ *     amount: 10,
+ *     reference: "payment",
+ *     reference_id: "payment_123",
+ *     metadata: {
+ *       key: "value",
+ *     },
+ *   }
+ * })
+ */
+export declare const createCartCreditLinesWorkflow: import("@medusajs/framework/workflows-sdk").ReturnWorkflow<CreateCartCreditLinesWorkflowInput, CartCreditLineDTO[], []>;
 //# sourceMappingURL=create-cart-credit-lines.d.ts.map

package/dist/cart/workflows/create-cart-credit-lines.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-cart-credit-lines.d.ts","sourceRoot":"","sources":["../../../src/cart/workflows/create-cart-credit-lines.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,uBAAuB,EACxB,MAAM,2BAA2B,CAAA;AASlC,eAAO,MAAM,+BAA+B,6BAA6B,CAAA;AACzE,eAAO,MAAM,6BAA6B,gHAczC,CAAA"}
+{"version":3,"file":"create-cart-credit-lines.d.ts","sourceRoot":"","sources":["../../../src/cart/workflows/create-cart-credit-lines.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,kCAAkC,EACnC,MAAM,2BAA2B,CAAA;AASlC,eAAO,MAAM,+BAA+B,6BAA6B,CAAA;AACzE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,6BAA6B,yHAczC,CAAA"}

package/dist/cart/workflows/create-cart-credit-lines.js

@@ -5,6 +5,23 @@ const utils_1 = require("@medusajs/framework/utils");
 const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
 const create_entities_1 = require("../../common/steps/create-entities");
 exports.createCartCreditLinesWorkflowId = "create-cart-credit-lines";
+/**
+ * This workflow creates one or more credit lines for a cart.
+ *
+ * @example
+ * const { result } = await createCartCreditLinesWorkflow(container)
+ * .run({
+ *   input: {
+ *     cart_id: "cart_123",
+ *     amount: 10,
+ *     reference: "payment",
+ *     reference_id: "payment_123",
+ *     metadata: {
+ *       key: "value",
+ *     },
+ *   }
+ * })
+ */
 exports.createCartCreditLinesWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.createCartCreditLinesWorkflowId, (input) => {
     const creditLines = (0, create_entities_1.createEntitiesStep)({
         moduleRegistrationName: utils_1.Modules.CART,

package/dist/cart/workflows/create-cart-credit-lines.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-cart-credit-lines.js","sourceRoot":"","sources":["../../../src/cart/workflows/create-cart-credit-lines.ts"],"names":[],"mappings":";;;AAIA,qDAAmD;AACnD,qEAI0C;AAC1C,wEAAuE;AAE1D,QAAA,+BAA+B,GAAG,0BAA0B,CAAA;AAC5D,QAAA,6BAA6B,GAAG,IAAA,8BAAc,EACzD,uCAA+B,EAC/B,CACE,KAA8C,EACP,EAAE;IACzC,MAAM,WAAW,GAAG,IAAA,oCAAkB,EAAC;QACrC,sBAAsB,EAAE,eAAO,CAAC,IAAI;QACpC,YAAY,EAAE,mBAAmB;QACjC,gBAAgB,EAAE,mBAAmB;QACrC,IAAI,EAAE,KAAK;KACZ,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,WAAW,CAAC,CAAA;AAC1C,CAAC,CACF,CAAA"}
+{"version":3,"file":"create-cart-credit-lines.js","sourceRoot":"","sources":["../../../src/cart/workflows/create-cart-credit-lines.ts"],"names":[],"mappings":";;;AAIA,qDAAmD;AACnD,qEAI0C;AAC1C,wEAAuE;AAE1D,QAAA,+BAA+B,GAAG,0BAA0B,CAAA;AACzE;;;;;;;;;;;;;;;;GAgBG;AACU,QAAA,6BAA6B,GAAG,IAAA,8BAAc,EACzD,uCAA+B,EAC/B,CACE,KAAuD,EAChB,EAAE;IACzC,MAAM,WAAW,GAAG,IAAA,oCAAkB,EAAC;QACrC,sBAAsB,EAAE,eAAO,CAAC,IAAI;QACpC,YAAY,EAAE,mBAAmB;QACjC,gBAAgB,EAAE,mBAAmB;QACrC,IAAI,EAAE,KAAK;KACZ,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,WAAW,CAAC,CAAA;AAC1C,CAAC,CACF,CAAA"}

package/dist/cart/workflows/delete-cart-credit-lines.d.ts

@@ -1,5 +1,11 @@
 export declare const deleteCartCreditLinesWorkflowId = "delete-cart-credit-lines";
+/**
+ * This workflow deletes one or more credit lines from a cart.
+ */
 export declare const deleteCartCreditLinesWorkflow: import("@medusajs/framework/workflows-sdk").ReturnWorkflow<{
+    /**
+     * The IDs of the credit lines to delete.
+     */
     id: string[];
 }, undefined, []>;
 //# sourceMappingURL=delete-cart-credit-lines.d.ts.map

package/dist/cart/workflows/delete-cart-credit-lines.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"delete-cart-credit-lines.d.ts","sourceRoot":"","sources":["../../../src/cart/workflows/delete-cart-credit-lines.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,+BAA+B,6BAA6B,CAAA;AACzE,eAAO,MAAM,6BAA6B;QAEb,MAAM,EAAE;iBAUpC,CAAA"}
+{"version":3,"file":"delete-cart-credit-lines.d.ts","sourceRoot":"","sources":["../../../src/cart/workflows/delete-cart-credit-lines.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,+BAA+B,6BAA6B,CAAA;AACzE;;GAEG;AACH,eAAO,MAAM,6BAA6B;IAGtC;;OAEG;QACC,MAAM,EAAE;iBAWf,CAAA"}

package/dist/cart/workflows/delete-cart-credit-lines.js

@@ -5,6 +5,9 @@ const utils_1 = require("@medusajs/framework/utils");
 const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
 const delete_entities_1 = require("../../common/steps/delete-entities");
 exports.deleteCartCreditLinesWorkflowId = "delete-cart-credit-lines";
+/**
+ * This workflow deletes one or more credit lines from a cart.
+ */
 exports.deleteCartCreditLinesWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.deleteCartCreditLinesWorkflowId, (input) => {
     (0, delete_entities_1.deleteEntitiesStep)({
         moduleRegistrationName: utils_1.Modules.CART,

package/dist/cart/workflows/delete-cart-credit-lines.js.map

@@ -1 +1 @@
-{"version":3,"file":"delete-cart-credit-lines.js","sourceRoot":"","sources":["../../../src/cart/workflows/delete-cart-credit-lines.ts"],"names":[],"mappings":";;;AAAA,qDAAmD;AACnD,qEAI0C;AAC1C,wEAAuE;AAE1D,QAAA,+BAA+B,GAAG,0BAA0B,CAAA;AAC5D,QAAA,6BAA6B,GAAG,IAAA,8BAAc,EACzD,uCAA+B,EAC/B,CAAC,KAAqC,EAAE,EAAE;IACxC,IAAA,oCAAkB,EAAC;QACjB,sBAAsB,EAAE,eAAO,CAAC,IAAI;QACpC,YAAY,EAAE,uBAAuB;QACrC,gBAAgB,EAAE,oBAAoB;QACtC,IAAI,EAAE,KAAK,CAAC,EAAE;KACf,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,KAAK,CAAC,CAAC,CAAA;AACrC,CAAC,CACF,CAAA"}
+{"version":3,"file":"delete-cart-credit-lines.js","sourceRoot":"","sources":["../../../src/cart/workflows/delete-cart-credit-lines.ts"],"names":[],"mappings":";;;AAAA,qDAAmD;AACnD,qEAI0C;AAC1C,wEAAuE;AAE1D,QAAA,+BAA+B,GAAG,0BAA0B,CAAA;AACzE;;GAEG;AACU,QAAA,6BAA6B,GAAG,IAAA,8BAAc,EACzD,uCAA+B,EAC/B,CAAC,KAKC,EAAE,EAAE;IACJ,IAAA,oCAAkB,EAAC;QACjB,sBAAsB,EAAE,eAAO,CAAC,IAAI;QACpC,YAAY,EAAE,uBAAuB;QACrC,gBAAgB,EAAE,oBAAoB;QACtC,IAAI,EAAE,KAAK,CAAC,EAAE;KACf,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,KAAK,CAAC,CAAC,CAAA;AACrC,CAAC,CACF,CAAA"}

package/dist/common/index.d.ts

@@ -1,5 +1,7 @@
+export * from "./steps/create-entities";
 export * from "./steps/create-remote-links";
 export * from "./steps/dismiss-remote-links";
+export * from "./steps/delete-entities";
 export * from "./steps/emit-event";
 export * from "./steps/remove-remote-links";
 export * from "./steps/update-remote-links";

package/dist/common/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAA;AAC3C,cAAc,8BAA8B,CAAA;AAC5C,cAAc,oBAAoB,CAAA;AAClC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,2BAA2B,CAAA;AACzC,cAAc,0BAA0B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA;AACvC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,8BAA8B,CAAA;AAC5C,cAAc,yBAAyB,CAAA;AACvC,cAAc,oBAAoB,CAAA;AAClC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,2BAA2B,CAAA;AACzC,cAAc,0BAA0B,CAAA"}

package/dist/common/index.js

@@ -14,8 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./steps/create-entities"), exports);
 __exportStar(require("./steps/create-remote-links"), exports);
 __exportStar(require("./steps/dismiss-remote-links"), exports);
+__exportStar(require("./steps/delete-entities"), exports);
 __exportStar(require("./steps/emit-event"), exports);
 __exportStar(require("./steps/remove-remote-links"), exports);
 __exportStar(require("./steps/update-remote-links"), exports);

package/dist/common/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8DAA2C;AAC3C,+DAA4C;AAC5C,qDAAkC;AAClC,8DAA2C;AAC3C,8DAA2C;AAC3C,0DAAuC;AACvC,2DAAwC;AACxC,+DAA4C;AAC5C,0DAAuC;AACvC,2DAAwC;AACxC,4DAAyC;AACzC,2DAAwC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAuC;AACvC,8DAA2C;AAC3C,+DAA4C;AAC5C,0DAAuC;AACvC,qDAAkC;AAClC,8DAA2C;AAC3C,8DAA2C;AAC3C,0DAAuC;AACvC,2DAAwC;AACxC,+DAA4C;AAC5C,0DAAuC;AACvC,2DAAwC;AACxC,4DAAyC;AACzC,2DAAwC"}

package/dist/common/steps/create-entities.d.ts

@@ -1,13 +1,45 @@
 export interface CreateEntitiesStepType {
+    /**
+     * The regitration name of the module that contains the method to be invoked.
+     */
     moduleRegistrationName: string;
+    /**
+     * The method to be invoked.
+     */
     invokeMethod: string;
+    /**
+     * The method to be invoked in case of compensation (when an error occurs).
+     */
     compensateMethod: string;
+    /**
+     * A string to pass to the compensate method.
+     */
     entityIdentifier?: string;
+    /**
+     * The data to pass to the invoke method.
+     * For example, an array of objects to create.
+     */
     data: any[];
 }
 export declare const createEntitiesStepId = "create-entities-step";
 /**
- * This step creates entities for any given module or resource
+ * This step creates one or more entities using methods in a module's service.
+ *
+ * @example
+ * createEntitiesStep({
+ *   moduleRegistrationName: Modules.CART,
+ *   invokeMethod: "createCreditLines",
+ *   compensateMethod: "deleteCreditLines",
+ *   data: {
+ *     cart_id: "cart_123",
+ *     amount: 10,
+ *     reference: "payment",
+ *     reference_id: "payment_123",
+ *     metadata: {
+ *       key: "value",
+ *     },
+ *   },
+ * })
  */
 export declare const createEntitiesStep: import("@medusajs/framework/workflows-sdk").StepFunction<CreateEntitiesStepType, any[]>;
 //# sourceMappingURL=create-entities.d.ts.map

package/dist/common/steps/create-entities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-entities.d.ts","sourceRoot":"","sources":["../../../src/common/steps/create-entities.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,sBAAsB;IACrC,sBAAsB,EAAE,MAAM,CAAA;IAC9B,YAAY,EAAE,MAAM,CAAA;IACpB,gBAAgB,EAAE,MAAM,CAAA;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,IAAI,EAAE,GAAG,EAAE,CAAA;CACZ;AAED,eAAO,MAAM,oBAAoB,yBAAyB,CAAA;AAC1D;;GAEG;AACH,eAAO,MAAM,kBAAkB,yFAmC9B,CAAA"}
+{"version":3,"file":"create-entities.d.ts","sourceRoot":"","sources":["../../../src/common/steps/create-entities.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAA;IAC9B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;OAGG;IACH,IAAI,EAAE,GAAG,EAAE,CAAA;CACZ;AAED,eAAO,MAAM,oBAAoB,yBAAyB,CAAA;AAC1D;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,kBAAkB,yFAmC9B,CAAA"}

package/dist/common/steps/create-entities.js

@@ -4,7 +4,23 @@ exports.createEntitiesStep = exports.createEntitiesStepId = void 0;
 const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
 exports.createEntitiesStepId = "create-entities-step";
 /**
- * This step creates entities for any given module or resource
+ * This step creates one or more entities using methods in a module's service.
+ *
+ * @example
+ * createEntitiesStep({
+ *   moduleRegistrationName: Modules.CART,
+ *   invokeMethod: "createCreditLines",
+ *   compensateMethod: "deleteCreditLines",
+ *   data: {
+ *     cart_id: "cart_123",
+ *     amount: 10,
+ *     reference: "payment",
+ *     reference_id: "payment_123",
+ *     metadata: {
+ *       key: "value",
+ *     },
+ *   },
+ * })
  */
 exports.createEntitiesStep = (0, workflows_sdk_1.createStep)(exports.createEntitiesStepId, async (input, { container }) => {
     const { moduleRegistrationName, invokeMethod, compensateMethod, entityIdentifier = "id", data = [], } = input;

package/dist/common/steps/create-entities.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-entities.js","sourceRoot":"","sources":["../../../src/common/steps/create-entities.ts"],"names":[],"mappings":";;;AAAA,qEAA4E;AAU/D,QAAA,oBAAoB,GAAG,sBAAsB,CAAA;AAC1D;;GAEG;AACU,QAAA,kBAAkB,GAAG,IAAA,0BAAU,EAC1C,4BAAoB,EACpB,KAAK,EAAE,KAA6B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACrD,MAAM,EACJ,sBAAsB,EACtB,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,GAAG,IAAI,EACvB,IAAI,GAAG,EAAE,GACV,GAAG,KAAK,CAAA;IAET,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAM,sBAAsB,CAAC,CAAA;IAC7D,MAAM,OAAO,GAAU,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IAE1E,OAAO,IAAI,4BAAY,CAAC,OAAO,EAAE;QAC/B,iBAAiB,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;QAC1D,sBAAsB;QACtB,gBAAgB;KACjB,CAAC,CAAA;AACJ,CAAC,EACD,KAAK,EAAE,eAAe,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACvC,MAAM,EACJ,iBAAiB,GAAG,EAAE,EACtB,sBAAsB,EACtB,gBAAgB,GACjB,GAAG,eAAgB,CAAA;IAEpB,IAAI,CAAC,iBAAiB,EAAE,MAAM,EAAE,CAAC;QAC/B,OAAM;IACR,CAAC;IAED,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAM,sBAAsB,CAAC,CAAA;IAE7D,MAAM,MAAM,CAAC,gBAAgB,CAAC,CAAC,iBAAiB,CAAC,CAAA;AACnD,CAAC,CACF,CAAA"}
+{"version":3,"file":"create-entities.js","sourceRoot":"","sources":["../../../src/common/steps/create-entities.ts"],"names":[],"mappings":";;;AAAA,qEAA4E;AA0B/D,QAAA,oBAAoB,GAAG,sBAAsB,CAAA;AAC1D;;;;;;;;;;;;;;;;;;GAkBG;AACU,QAAA,kBAAkB,GAAG,IAAA,0BAAU,EAC1C,4BAAoB,EACpB,KAAK,EAAE,KAA6B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACrD,MAAM,EACJ,sBAAsB,EACtB,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,GAAG,IAAI,EACvB,IAAI,GAAG,EAAE,GACV,GAAG,KAAK,CAAA;IAET,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAM,sBAAsB,CAAC,CAAA;IAC7D,MAAM,OAAO,GAAU,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IAE1E,OAAO,IAAI,4BAAY,CAAC,OAAO,EAAE;QAC/B,iBAAiB,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;QAC1D,sBAAsB;QACtB,gBAAgB;KACjB,CAAC,CAAA;AACJ,CAAC,EACD,KAAK,EAAE,eAAe,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACvC,MAAM,EACJ,iBAAiB,GAAG,EAAE,EACtB,sBAAsB,EACtB,gBAAgB,GACjB,GAAG,eAAgB,CAAA;IAEpB,IAAI,CAAC,iBAAiB,EAAE,MAAM,EAAE,CAAC;QAC/B,OAAM;IACR,CAAC;IAED,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAM,sBAAsB,CAAC,CAAA;IAE7D,MAAM,MAAM,CAAC,gBAAgB,CAAC,CAAC,iBAAiB,CAAC,CAAA;AACnD,CAAC,CACF,CAAA"}

package/dist/common/steps/delete-entities.d.ts

@@ -1,13 +1,38 @@
 export interface DeleteEntitiesStepType {
+    /**
+     * The regitration name of the module that contains the method to be invoked.
+     */
     moduleRegistrationName: string;
+    /**
+     * The method to be invoked.
+     */
     invokeMethod: string;
+    /**
+     * The method to be invoked in case of compensation (when an error occurs).
+     */
     compensateMethod: string;
+    /**
+     * A string to pass to the compensate method.
+     * For example, an ID of the entity to be deleted.
+     */
     entityIdentifier?: string;
+    /**
+     * The data to pass to the invoke method.
+     * For example, an array of IDs to delete.
+     */
     data: any[];
 }
 export declare const deleteEntitiesStepId = "delete-entities-step";
 /**
- * This step deletes one or more entities.
+ * This step deletes one or more entities using methods in a module's service.
+ *
+ * @example
+ * deleteEntitiesStep({
+ *   moduleRegistrationName: Modules.CART,
+ *   invokeMethod: "softDeleteCreditLines",
+ *   compensateMethod: "restoreCreditLines",
+ *   data: input.id,
+ * })
  */
 export declare const deleteEntitiesStep: import("@medusajs/framework/workflows-sdk").StepFunction<DeleteEntitiesStepType, undefined>;
 //# sourceMappingURL=delete-entities.d.ts.map

package/dist/common/steps/delete-entities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"delete-entities.d.ts","sourceRoot":"","sources":["../../../src/common/steps/delete-entities.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,sBAAsB;IACrC,sBAAsB,EAAE,MAAM,CAAA;IAC9B,YAAY,EAAE,MAAM,CAAA;IACpB,gBAAgB,EAAE,MAAM,CAAA;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,IAAI,EAAE,GAAG,EAAE,CAAA;CACZ;AAED,eAAO,MAAM,oBAAoB,yBAAyB,CAAA;AAC1D;;GAEG;AACH,eAAO,MAAM,kBAAkB,6FAkC9B,CAAA"}
+{"version":3,"file":"delete-entities.d.ts","sourceRoot":"","sources":["../../../src/common/steps/delete-entities.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAA;IAC9B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAA;IACxB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;OAGG;IACH,IAAI,EAAE,GAAG,EAAE,CAAA;CACZ;AAED,eAAO,MAAM,oBAAoB,yBAAyB,CAAA;AAC1D;;;;;;;;;;GAUG;AACH,eAAO,MAAM,kBAAkB,6FAkC9B,CAAA"}

package/dist/common/steps/delete-entities.js

@@ -4,7 +4,15 @@ exports.deleteEntitiesStep = exports.deleteEntitiesStepId = void 0;
 const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
 exports.deleteEntitiesStepId = "delete-entities-step";
 /**
- * This step deletes one or more entities.
+ * This step deletes one or more entities using methods in a module's service.
+ *
+ * @example
+ * deleteEntitiesStep({
+ *   moduleRegistrationName: Modules.CART,
+ *   invokeMethod: "softDeleteCreditLines",
+ *   compensateMethod: "restoreCreditLines",
+ *   data: input.id,
+ * })
  */
 exports.deleteEntitiesStep = (0, workflows_sdk_1.createStep)(exports.deleteEntitiesStepId, async (input, { container }) => {
     const { moduleRegistrationName, invokeMethod, compensateMethod, data = [], } = input;

package/dist/common/steps/delete-entities.js.map

@@ -1 +1 @@
-{"version":3,"file":"delete-entities.js","sourceRoot":"","sources":["../../../src/common/steps/delete-entities.ts"],"names":[],"mappings":";;;AAAA,qEAA4E;AAU/D,QAAA,oBAAoB,GAAG,sBAAsB,CAAA;AAC1D;;GAEG;AACU,QAAA,kBAAkB,GAAG,IAAA,0BAAU,EAC1C,4BAAoB,EACpB,KAAK,EAAE,KAA6B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACrD,MAAM,EACJ,sBAAsB,EACtB,YAAY,EACZ,gBAAgB,EAChB,IAAI,GAAG,EAAE,GACV,GAAG,KAAK,CAAA;IAET,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAM,sBAAsB,CAAC,CAAA;IAC7D,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IAEnD,OAAO,IAAI,4BAAY,CAAC,KAAK,CAAC,EAAE;QAC9B,iBAAiB,EAAE,KAAK,CAAC,IAAI;QAC7B,sBAAsB;QACtB,gBAAgB;KACjB,CAAC,CAAA;AACJ,CAAC,EACD,KAAK,EAAE,eAAe,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACvC,MAAM,EACJ,iBAAiB,GAAG,EAAE,EACtB,sBAAsB,EACtB,gBAAgB,GACjB,GAAG,eAAgB,CAAA;IAEpB,IAAI,CAAC,iBAAiB,EAAE,MAAM,EAAE,CAAC;QAC/B,OAAM;IACR,CAAC;IAED,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAM,sBAAsB,CAAC,CAAA;IAE7D,MAAM,MAAM,CAAC,gBAAgB,CAAC,CAAC,iBAAiB,CAAC,CAAA;AACnD,CAAC,CACF,CAAA"}
+{"version":3,"file":"delete-entities.js","sourceRoot":"","sources":["../../../src/common/steps/delete-entities.ts"],"names":[],"mappings":";;;AAAA,qEAA4E;AA2B/D,QAAA,oBAAoB,GAAG,sBAAsB,CAAA;AAC1D;;;;;;;;;;GAUG;AACU,QAAA,kBAAkB,GAAG,IAAA,0BAAU,EAC1C,4BAAoB,EACpB,KAAK,EAAE,KAA6B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACrD,MAAM,EACJ,sBAAsB,EACtB,YAAY,EACZ,gBAAgB,EAChB,IAAI,GAAG,EAAE,GACV,GAAG,KAAK,CAAA;IAET,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAM,sBAAsB,CAAC,CAAA;IAC7D,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IAEnD,OAAO,IAAI,4BAAY,CAAC,KAAK,CAAC,EAAE;QAC9B,iBAAiB,EAAE,KAAK,CAAC,IAAI;QAC7B,sBAAsB;QACtB,gBAAgB;KACjB,CAAC,CAAA;AACJ,CAAC,EACD,KAAK,EAAE,eAAe,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACvC,MAAM,EACJ,iBAAiB,GAAG,EAAE,EACtB,sBAAsB,EACtB,gBAAgB,GACjB,GAAG,eAAgB,CAAA;IAEpB,IAAI,CAAC,iBAAiB,EAAE,MAAM,EAAE,CAAC;QAC/B,OAAM;IACR,CAAC;IAED,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAM,sBAAsB,CAAC,CAAA;IAE7D,MAAM,MAAM,CAAC,gBAAgB,CAAC,CAAC,iBAAiB,CAAC,CAAA;AACnD,CAAC,CACF,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@medusajs/core-flows",
-  "version": "2.8.3-preview-20250521180140",
+  "version": "2.8.3-preview-20250522000308",
   "description": "Set of workflow definitions for Medusa",
   "main": "dist/index.js",
   "exports": {
@@ -26,7 +26,7 @@
   "author": "Medusa",
   "license": "MIT",
   "devDependencies": {
-    "@medusajs/framework": "2.8.3-preview-20250521180140",
+    "@medusajs/framework": "2.8.3-preview-20250522000308",
     "@mikro-orm/core": "6.4.3",
     "@mikro-orm/knex": "6.4.3",
     "@mikro-orm/migrations": "6.4.3",
@@ -44,7 +44,7 @@
     "json-2-csv": "^5.5.4"
   },
   "peerDependencies": {
-    "@medusajs/framework": "2.8.3-preview-20250521180140",
+    "@medusajs/framework": "2.8.3-preview-20250522000308",
     "awilix": "^8.0.1"
   },
   "scripts": {