@medusajs/core-flows 2.7.2-preview-20250424060234 → 2.7.2-preview-20250424090141

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (133) hide show
  1. package/dist/draft-order/steps/create-draft-order-line-item-adjustments.d.ts +25 -2
  2. package/dist/draft-order/steps/create-draft-order-line-item-adjustments.d.ts.map +1 -1
  3. package/dist/draft-order/steps/create-draft-order-line-item-adjustments.js +15 -0
  4. package/dist/draft-order/steps/create-draft-order-line-item-adjustments.js.map +1 -1
  5. package/dist/draft-order/steps/create-draft-order-shipping-method-adjustments.d.ts +21 -2
  6. package/dist/draft-order/steps/create-draft-order-shipping-method-adjustments.d.ts.map +1 -1
  7. package/dist/draft-order/steps/create-draft-order-shipping-method-adjustments.js +14 -0
  8. package/dist/draft-order/steps/create-draft-order-shipping-method-adjustments.js.map +1 -1
  9. package/dist/draft-order/steps/get-draft-order-promotion-context.d.ts +25 -2
  10. package/dist/draft-order/steps/get-draft-order-promotion-context.d.ts.map +1 -1
  11. package/dist/draft-order/steps/get-draft-order-promotion-context.js +18 -0
  12. package/dist/draft-order/steps/get-draft-order-promotion-context.js.map +1 -1
  13. package/dist/draft-order/steps/remove-draft-order-line-item-adjustments.d.ts +15 -2
  14. package/dist/draft-order/steps/remove-draft-order-line-item-adjustments.d.ts.map +1 -1
  15. package/dist/draft-order/steps/remove-draft-order-line-item-adjustments.js +8 -0
  16. package/dist/draft-order/steps/remove-draft-order-line-item-adjustments.js.map +1 -1
  17. package/dist/draft-order/steps/remove-draft-order-shipping-method-adjustments.d.ts +15 -2
  18. package/dist/draft-order/steps/remove-draft-order-shipping-method-adjustments.d.ts.map +1 -1
  19. package/dist/draft-order/steps/remove-draft-order-shipping-method-adjustments.js +8 -0
  20. package/dist/draft-order/steps/remove-draft-order-shipping-method-adjustments.js.map +1 -1
  21. package/dist/draft-order/steps/restore-draft-order-shipping-methods.d.ts +49 -2
  22. package/dist/draft-order/steps/restore-draft-order-shipping-methods.d.ts.map +1 -1
  23. package/dist/draft-order/steps/restore-draft-order-shipping-methods.js +21 -0
  24. package/dist/draft-order/steps/restore-draft-order-shipping-methods.js.map +1 -1
  25. package/dist/draft-order/steps/update-draft-order-promotions.d.ts +28 -2
  26. package/dist/draft-order/steps/update-draft-order-promotions.d.ts.map +1 -1
  27. package/dist/draft-order/steps/update-draft-order-promotions.js +11 -0
  28. package/dist/draft-order/steps/update-draft-order-promotions.js.map +1 -1
  29. package/dist/draft-order/steps/update-draft-order-shipping-metod.d.ts +29 -2
  30. package/dist/draft-order/steps/update-draft-order-shipping-metod.d.ts.map +1 -1
  31. package/dist/draft-order/steps/update-draft-order-shipping-metod.js +10 -0
  32. package/dist/draft-order/steps/update-draft-order-shipping-metod.js.map +1 -1
  33. package/dist/draft-order/steps/validate-draft-order-change.d.ts +33 -2
  34. package/dist/draft-order/steps/validate-draft-order-change.d.ts.map +1 -1
  35. package/dist/draft-order/steps/validate-draft-order-change.js +23 -0
  36. package/dist/draft-order/steps/validate-draft-order-change.js.map +1 -1
  37. package/dist/draft-order/steps/validate-draft-order-remove-action-item.d.ts +32 -0
  38. package/dist/draft-order/steps/validate-draft-order-remove-action-item.d.ts.map +1 -1
  39. package/dist/draft-order/steps/validate-draft-order-remove-action-item.js +23 -0
  40. package/dist/draft-order/steps/validate-draft-order-remove-action-item.js.map +1 -1
  41. package/dist/draft-order/steps/validate-draft-order-shipping-method-action.d.ts +32 -0
  42. package/dist/draft-order/steps/validate-draft-order-shipping-method-action.d.ts.map +1 -1
  43. package/dist/draft-order/steps/validate-draft-order-shipping-method-action.js +23 -0
  44. package/dist/draft-order/steps/validate-draft-order-shipping-method-action.js.map +1 -1
  45. package/dist/draft-order/steps/validate-draft-order-update-action-item.d.ts +32 -0
  46. package/dist/draft-order/steps/validate-draft-order-update-action-item.d.ts.map +1 -1
  47. package/dist/draft-order/steps/validate-draft-order-update-action-item.js +23 -0
  48. package/dist/draft-order/steps/validate-draft-order-update-action-item.js.map +1 -1
  49. package/dist/draft-order/steps/validate-draft-order.d.ts +25 -2
  50. package/dist/draft-order/steps/validate-draft-order.d.ts.map +1 -1
  51. package/dist/draft-order/steps/validate-draft-order.js +18 -0
  52. package/dist/draft-order/steps/validate-draft-order.js.map +1 -1
  53. package/dist/draft-order/steps/validate-promo-codes-to-add.d.ts +33 -2
  54. package/dist/draft-order/steps/validate-promo-codes-to-add.d.ts.map +1 -1
  55. package/dist/draft-order/steps/validate-promo-codes-to-add.js +23 -0
  56. package/dist/draft-order/steps/validate-promo-codes-to-add.js.map +1 -1
  57. package/dist/draft-order/steps/validate-promo-codes-to-remove.d.ts +33 -2
  58. package/dist/draft-order/steps/validate-promo-codes-to-remove.d.ts.map +1 -1
  59. package/dist/draft-order/steps/validate-promo-codes-to-remove.js +23 -0
  60. package/dist/draft-order/steps/validate-promo-codes-to-remove.js.map +1 -1
  61. package/dist/draft-order/workflows/add-draft-order-items.d.ts +23 -0
  62. package/dist/draft-order/workflows/add-draft-order-items.d.ts.map +1 -1
  63. package/dist/draft-order/workflows/add-draft-order-items.js +23 -0
  64. package/dist/draft-order/workflows/add-draft-order-items.js.map +1 -1
  65. package/dist/draft-order/workflows/add-draft-order-promotions.d.ts +30 -2
  66. package/dist/draft-order/workflows/add-draft-order-promotions.d.ts.map +1 -1
  67. package/dist/draft-order/workflows/add-draft-order-promotions.js +20 -0
  68. package/dist/draft-order/workflows/add-draft-order-promotions.js.map +1 -1
  69. package/dist/draft-order/workflows/add-draft-order-shipping-methods.d.ts +28 -4
  70. package/dist/draft-order/workflows/add-draft-order-shipping-methods.d.ts.map +1 -1
  71. package/dist/draft-order/workflows/add-draft-order-shipping-methods.js +21 -0
  72. package/dist/draft-order/workflows/add-draft-order-shipping-methods.js.map +1 -1
  73. package/dist/draft-order/workflows/begin-draft-order-edit.d.ts +21 -0
  74. package/dist/draft-order/workflows/begin-draft-order-edit.d.ts.map +1 -1
  75. package/dist/draft-order/workflows/begin-draft-order-edit.js +21 -0
  76. package/dist/draft-order/workflows/begin-draft-order-edit.js.map +1 -1
  77. package/dist/draft-order/workflows/cancel-draft-order-edit.d.ts +25 -0
  78. package/dist/draft-order/workflows/cancel-draft-order-edit.d.ts.map +1 -1
  79. package/dist/draft-order/workflows/cancel-draft-order-edit.js +19 -0
  80. package/dist/draft-order/workflows/cancel-draft-order-edit.js.map +1 -1
  81. package/dist/draft-order/workflows/confirm-draft-order-edit.d.ts +20 -0
  82. package/dist/draft-order/workflows/confirm-draft-order-edit.d.ts.map +1 -1
  83. package/dist/draft-order/workflows/confirm-draft-order-edit.js +20 -0
  84. package/dist/draft-order/workflows/confirm-draft-order-edit.js.map +1 -1
  85. package/dist/draft-order/workflows/convert-draft-order.d.ts +35 -6
  86. package/dist/draft-order/workflows/convert-draft-order.d.ts.map +1 -1
  87. package/dist/draft-order/workflows/convert-draft-order.js +18 -12
  88. package/dist/draft-order/workflows/convert-draft-order.js.map +1 -1
  89. package/dist/draft-order/workflows/refresh-draft-order-adjustments.d.ts +41 -2
  90. package/dist/draft-order/workflows/refresh-draft-order-adjustments.d.ts.map +1 -1
  91. package/dist/draft-order/workflows/refresh-draft-order-adjustments.js +23 -0
  92. package/dist/draft-order/workflows/refresh-draft-order-adjustments.js.map +1 -1
  93. package/dist/draft-order/workflows/remove-draft-order-action-item.d.ts +20 -0
  94. package/dist/draft-order/workflows/remove-draft-order-action-item.d.ts.map +1 -1
  95. package/dist/draft-order/workflows/remove-draft-order-action-item.js +20 -0
  96. package/dist/draft-order/workflows/remove-draft-order-action-item.js.map +1 -1
  97. package/dist/draft-order/workflows/remove-draft-order-action-shipping-method.d.ts +20 -0
  98. package/dist/draft-order/workflows/remove-draft-order-action-shipping-method.d.ts.map +1 -1
  99. package/dist/draft-order/workflows/remove-draft-order-action-shipping-method.js +20 -0
  100. package/dist/draft-order/workflows/remove-draft-order-action-shipping-method.js.map +1 -1
  101. package/dist/draft-order/workflows/remove-draft-order-promotions.d.ts +30 -2
  102. package/dist/draft-order/workflows/remove-draft-order-promotions.d.ts.map +1 -1
  103. package/dist/draft-order/workflows/remove-draft-order-promotions.js +20 -0
  104. package/dist/draft-order/workflows/remove-draft-order-promotions.js.map +1 -1
  105. package/dist/draft-order/workflows/remove-draft-order-shipping-method.d.ts +25 -3
  106. package/dist/draft-order/workflows/remove-draft-order-shipping-method.d.ts.map +1 -1
  107. package/dist/draft-order/workflows/remove-draft-order-shipping-method.js +20 -0
  108. package/dist/draft-order/workflows/remove-draft-order-shipping-method.js.map +1 -1
  109. package/dist/draft-order/workflows/request-draft-order-edit.d.ts +20 -0
  110. package/dist/draft-order/workflows/request-draft-order-edit.d.ts.map +1 -1
  111. package/dist/draft-order/workflows/request-draft-order-edit.js +20 -0
  112. package/dist/draft-order/workflows/request-draft-order-edit.js.map +1 -1
  113. package/dist/draft-order/workflows/update-draft-order-action-item.d.ts +23 -0
  114. package/dist/draft-order/workflows/update-draft-order-action-item.d.ts.map +1 -1
  115. package/dist/draft-order/workflows/update-draft-order-action-item.js +23 -0
  116. package/dist/draft-order/workflows/update-draft-order-action-item.js.map +1 -1
  117. package/dist/draft-order/workflows/update-draft-order-action-shipping-method.d.ts +23 -0
  118. package/dist/draft-order/workflows/update-draft-order-action-shipping-method.d.ts.map +1 -1
  119. package/dist/draft-order/workflows/update-draft-order-action-shipping-method.js +23 -0
  120. package/dist/draft-order/workflows/update-draft-order-action-shipping-method.js.map +1 -1
  121. package/dist/draft-order/workflows/update-draft-order-item.d.ts +20 -0
  122. package/dist/draft-order/workflows/update-draft-order-item.d.ts.map +1 -1
  123. package/dist/draft-order/workflows/update-draft-order-item.js +20 -0
  124. package/dist/draft-order/workflows/update-draft-order-item.js.map +1 -1
  125. package/dist/draft-order/workflows/update-draft-order-shipping-method.d.ts +27 -1
  126. package/dist/draft-order/workflows/update-draft-order-shipping-method.d.ts.map +1 -1
  127. package/dist/draft-order/workflows/update-draft-order-shipping-method.js +23 -0
  128. package/dist/draft-order/workflows/update-draft-order-shipping-method.js.map +1 -1
  129. package/dist/draft-order/workflows/update-draft-order.d.ts +65 -1
  130. package/dist/draft-order/workflows/update-draft-order.d.ts.map +1 -1
  131. package/dist/draft-order/workflows/update-draft-order.js +50 -3
  132. package/dist/draft-order/workflows/update-draft-order.js.map +1 -1
  133. package/package.json +3 -3
@@ -1,9 +1,40 @@
1
1
  import { OrderChangeDTO, OrderDTO } from "@medusajs/types";
2
- interface ValidateDraftOrderChangeStepInput {
2
+ /**
3
+ * The details of the draft order and its change to validate.
4
+ */
5
+ export interface ValidateDraftOrderChangeStepInput {
6
+ /**
7
+ * The draft order to validate.
8
+ */
3
9
  order: OrderDTO;
10
+ /**
11
+ * The order change to validate.
12
+ */
4
13
  orderChange: OrderChangeDTO;
5
14
  }
6
15
  export declare const validateDraftOrderChangeStepId = "validate-draft-order-change";
16
+ /**
17
+ * This step validates that a draft order and its change are valid. It throws an error if the
18
+ * order is not a draft order or the order change is not active.
19
+ *
20
+ * :::note
21
+ *
22
+ * You can retrieve a draft order and its change's details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query),
23
+ * or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep).
24
+ *
25
+ * :::
26
+ *
27
+ * @example
28
+ * const data = validateDraftOrderChangeStep({
29
+ * order: {
30
+ * id: "order_123",
31
+ * // other order details...
32
+ * },
33
+ * orderChange: {
34
+ * id: "orch_123",
35
+ * // other order change details...
36
+ * }
37
+ * })
38
+ */
7
39
  export declare const validateDraftOrderChangeStep: import("@medusajs/framework/workflows-sdk").StepFunction<ValidateDraftOrderChangeStepInput, unknown>;
8
- export {};
9
40
  //# sourceMappingURL=validate-draft-order-change.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"validate-draft-order-change.d.ts","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-draft-order-change.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAI1D,UAAU,iCAAiC;IACzC,KAAK,EAAE,QAAQ,CAAA;IACf,WAAW,EAAE,cAAc,CAAA;CAC5B;AAED,eAAO,MAAM,8BAA8B,gCAAgC,CAAA;AAE3E,eAAO,MAAM,4BAA4B,sGAMxC,CAAA"}
1
+ {"version":3,"file":"validate-draft-order-change.d.ts","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-draft-order-change.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAI1D;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAA;IACf;;OAEG;IACH,WAAW,EAAE,cAAc,CAAA;CAC5B;AAED,eAAO,MAAM,8BAA8B,gCAAgC,CAAA;AAE3E;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,4BAA4B,sGAMxC,CAAA"}
@@ -5,6 +5,29 @@ const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
5
5
  const order_validation_1 = require("../../order/utils/order-validation");
6
6
  const validation_1 = require("../utils/validation");
7
7
  exports.validateDraftOrderChangeStepId = "validate-draft-order-change";
8
+ /**
9
+ * This step validates that a draft order and its change are valid. It throws an error if the
10
+ * order is not a draft order or the order change is not active.
11
+ *
12
+ * :::note
13
+ *
14
+ * You can retrieve a draft order and its change's details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query),
15
+ * or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep).
16
+ *
17
+ * :::
18
+ *
19
+ * @example
20
+ * const data = validateDraftOrderChangeStep({
21
+ * order: {
22
+ * id: "order_123",
23
+ * // other order details...
24
+ * },
25
+ * orderChange: {
26
+ * id: "orch_123",
27
+ * // other order change details...
28
+ * }
29
+ * })
30
+ */
8
31
  exports.validateDraftOrderChangeStep = (0, workflows_sdk_1.createStep)(exports.validateDraftOrderChangeStepId, async function ({ order, orderChange }) {
9
32
  (0, validation_1.throwIfNotDraftOrder)({ order });
10
33
  (0, order_validation_1.throwIfOrderChangeIsNotActive)({ orderChange });
@@ -1 +1 @@
1
- {"version":3,"file":"validate-draft-order-change.js","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-draft-order-change.ts"],"names":[],"mappings":";;;AAAA,qEAA8D;AAE9D,yEAAkF;AAClF,oDAA0D;AAO7C,QAAA,8BAA8B,GAAG,6BAA6B,CAAA;AAE9D,QAAA,4BAA4B,GAAG,IAAA,0BAAU,EACpD,sCAA8B,EAC9B,KAAK,WAAW,EAAE,KAAK,EAAE,WAAW,EAAqC;IACvE,IAAA,iCAAoB,EAAC,EAAE,KAAK,EAAE,CAAC,CAAA;IAC/B,IAAA,gDAA6B,EAAC,EAAE,WAAW,EAAE,CAAC,CAAA;AAChD,CAAC,CACF,CAAA"}
1
+ {"version":3,"file":"validate-draft-order-change.js","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-draft-order-change.ts"],"names":[],"mappings":";;;AAAA,qEAA8D;AAE9D,yEAAkF;AAClF,oDAA0D;AAgB7C,QAAA,8BAA8B,GAAG,6BAA6B,CAAA;AAE3E;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACU,QAAA,4BAA4B,GAAG,IAAA,0BAAU,EACpD,sCAA8B,EAC9B,KAAK,WAAW,EAAE,KAAK,EAAE,WAAW,EAAqC;IACvE,IAAA,iCAAoB,EAAC,EAAE,KAAK,EAAE,CAAC,CAAA;IAC/B,IAAA,gDAA6B,EAAC,EAAE,WAAW,EAAE,CAAC,CAAA;AAChD,CAAC,CACF,CAAA"}
@@ -1,7 +1,39 @@
1
1
  import { OrderChangeDTO, OrderWorkflow } from "@medusajs/types";
2
+ /**
3
+ * The details of the draft order and its change to validate.
4
+ */
2
5
  export interface ValidateDraftOrderUpdateActionItemStepInput {
6
+ /**
7
+ * The details of the item removal action.
8
+ */
3
9
  input: OrderWorkflow.DeleteOrderEditItemActionWorkflowInput;
10
+ /**
11
+ * The order change to validate.
12
+ */
4
13
  orderChange: OrderChangeDTO;
5
14
  }
15
+ /**
16
+ * This step validates that an item change can be removed from a draft order edit. It throws an error if the
17
+ * item change is not in the draft order edit, or if the item change is not adding or updating an item.
18
+ *
19
+ * :::note
20
+ *
21
+ * You can retrieve a draft order change's details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query),
22
+ * or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep).
23
+ *
24
+ * :::
25
+ *
26
+ * @example
27
+ * const data = validateDraftOrderRemoveActionItemStep({
28
+ * input: {
29
+ * action_id: "action_123",
30
+ * order_id: "order_123",
31
+ * },
32
+ * orderChange: {
33
+ * id: "orch_123",
34
+ * // other order change details...
35
+ * }
36
+ * })
37
+ */
6
38
  export declare const validateDraftOrderRemoveActionItemStep: import("@medusajs/framework/workflows-sdk").StepFunction<ValidateDraftOrderUpdateActionItemStepInput, unknown>;
7
39
  //# sourceMappingURL=validate-draft-order-remove-action-item.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"validate-draft-order-remove-action-item.d.ts","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-draft-order-remove-action-item.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/D,MAAM,WAAW,2CAA2C;IAC1D,KAAK,EAAE,aAAa,CAAC,sCAAsC,CAAA;IAC3D,WAAW,EAAE,cAAc,CAAA;CAC5B;AAED,eAAO,MAAM,sCAAsC,gHA4BlD,CAAA"}
1
+ {"version":3,"file":"validate-draft-order-remove-action-item.d.ts","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-draft-order-remove-action-item.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/D;;GAEG;AACH,MAAM,WAAW,2CAA2C;IAC1D;;OAEG;IACH,KAAK,EAAE,aAAa,CAAC,sCAAsC,CAAA;IAC3D;;OAEG;IACH,WAAW,EAAE,cAAc,CAAA;CAC5B;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,sCAAsC,gHA4BlD,CAAA"}
@@ -3,6 +3,29 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.validateDraftOrderRemoveActionItemStep = void 0;
4
4
  const utils_1 = require("@medusajs/framework/utils");
5
5
  const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
6
+ /**
7
+ * This step validates that an item change can be removed from a draft order edit. It throws an error if the
8
+ * item change is not in the draft order edit, or if the item change is not adding or updating an item.
9
+ *
10
+ * :::note
11
+ *
12
+ * You can retrieve a draft order change's details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query),
13
+ * or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep).
14
+ *
15
+ * :::
16
+ *
17
+ * @example
18
+ * const data = validateDraftOrderRemoveActionItemStep({
19
+ * input: {
20
+ * action_id: "action_123",
21
+ * order_id: "order_123",
22
+ * },
23
+ * orderChange: {
24
+ * id: "orch_123",
25
+ * // other order change details...
26
+ * }
27
+ * })
28
+ */
6
29
  exports.validateDraftOrderRemoveActionItemStep = (0, workflows_sdk_1.createStep)("validate-draft-order-remove-action-item", async function ({ input, orderChange, }) {
7
30
  const associatedAction = (orderChange.actions ?? []).find((a) => a.id === input.action_id);
8
31
  if (!associatedAction) {
@@ -1 +1 @@
1
- {"version":3,"file":"validate-draft-order-remove-action-item.js","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-draft-order-remove-action-item.ts"],"names":[],"mappings":";;;AAEA,qDAAyE;AACzE,qEAA8D;AAQjD,QAAA,sCAAsC,GAAG,IAAA,0BAAU,EAC9D,yCAAyC,EACzC,KAAK,WAAW,EACd,KAAK,EACL,WAAW,GACiC;IAC5C,MAAM,gBAAgB,GAAG,CAAC,WAAW,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CACvD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,SAAS,CACR,CAAA;IAEzB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,MAAM,IAAI,mBAAW,CACnB,mBAAW,CAAC,KAAK,CAAC,YAAY,EAC9B,2BAA2B,KAAK,CAAC,QAAQ,oBAAoB,WAAW,CAAC,EAAE,EAAE,CAC9E,CAAA;IACH,CAAC;IAED,IACE,CAAC,CAAC,wBAAgB,CAAC,QAAQ,EAAE,wBAAgB,CAAC,WAAW,CAAC,CAAC,QAAQ,CACjE,gBAAgB,CAAC,MAA0B,CAC5C,EACD,CAAC;QACD,MAAM,IAAI,mBAAW,CACnB,mBAAW,CAAC,KAAK,CAAC,YAAY,EAC9B,UAAU,gBAAgB,CAAC,EAAE,oCAAoC,CAClE,CAAA;IACH,CAAC;AACH,CAAC,CACF,CAAA"}
1
+ {"version":3,"file":"validate-draft-order-remove-action-item.js","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-draft-order-remove-action-item.ts"],"names":[],"mappings":";;;AAEA,qDAAyE;AACzE,qEAA8D;AAiB9D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACU,QAAA,sCAAsC,GAAG,IAAA,0BAAU,EAC9D,yCAAyC,EACzC,KAAK,WAAW,EACd,KAAK,EACL,WAAW,GACiC;IAC5C,MAAM,gBAAgB,GAAG,CAAC,WAAW,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CACvD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,SAAS,CACR,CAAA;IAEzB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,MAAM,IAAI,mBAAW,CACnB,mBAAW,CAAC,KAAK,CAAC,YAAY,EAC9B,2BAA2B,KAAK,CAAC,QAAQ,oBAAoB,WAAW,CAAC,EAAE,EAAE,CAC9E,CAAA;IACH,CAAC;IAED,IACE,CAAC,CAAC,wBAAgB,CAAC,QAAQ,EAAE,wBAAgB,CAAC,WAAW,CAAC,CAAC,QAAQ,CACjE,gBAAgB,CAAC,MAA0B,CAC5C,EACD,CAAC;QACD,MAAM,IAAI,mBAAW,CACnB,mBAAW,CAAC,KAAK,CAAC,YAAY,EAC9B,UAAU,gBAAgB,CAAC,EAAE,oCAAoC,CAClE,CAAA;IACH,CAAC;AACH,CAAC,CACF,CAAA"}
@@ -1,7 +1,39 @@
1
1
  import { OrderChangeDTO, OrderWorkflow } from "@medusajs/types";
2
+ /**
3
+ * The details of the draft order and its change to validate.
4
+ */
2
5
  export interface ValidateDraftOrderShippingMethodActionStepInput {
6
+ /**
7
+ * The details of the shipping method removal action.
8
+ */
3
9
  input: OrderWorkflow.DeleteOrderEditShippingMethodWorkflowInput;
10
+ /**
11
+ * The order change to validate.
12
+ */
4
13
  orderChange: OrderChangeDTO;
5
14
  }
15
+ /**
16
+ * This step validates that a shipping method change can be removed from a draft order edit. It throws an error if the
17
+ * shipping method change is not in the draft order edit, or if the shipping method change is not adding a shipping method.
18
+ *
19
+ * :::note
20
+ *
21
+ * You can retrieve a draft order change's details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query),
22
+ * or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep).
23
+ *
24
+ * :::
25
+ *
26
+ * @example
27
+ * const data = validateDraftOrderShippingMethodActionStep({
28
+ * input: {
29
+ * action_id: "action_123",
30
+ * order_id: "order_123",
31
+ * },
32
+ * orderChange: {
33
+ * id: "orch_123",
34
+ * // other order change details...
35
+ * }
36
+ * })
37
+ */
6
38
  export declare const validateDraftOrderShippingMethodActionStep: import("@medusajs/framework/workflows-sdk").StepFunction<ValidateDraftOrderShippingMethodActionStepInput, unknown>;
7
39
  //# sourceMappingURL=validate-draft-order-shipping-method-action.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"validate-draft-order-shipping-method-action.d.ts","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-draft-order-shipping-method-action.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,cAAc,EACd,aAAa,EACd,MAAM,iBAAiB,CAAA;AAExB,MAAM,WAAW,+CAA+C;IAC9D,KAAK,EAAE,aAAa,CAAC,0CAA0C,CAAA;IAC/D,WAAW,EAAE,cAAc,CAAA;CAC5B;AAED,eAAO,MAAM,0CAA0C,oHAwBtD,CAAA"}
1
+ {"version":3,"file":"validate-draft-order-shipping-method-action.d.ts","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-draft-order-shipping-method-action.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,cAAc,EACd,aAAa,EACd,MAAM,iBAAiB,CAAA;AAExB;;GAEG;AACH,MAAM,WAAW,+CAA+C;IAC9D;;OAEG;IACH,KAAK,EAAE,aAAa,CAAC,0CAA0C,CAAA;IAC/D;;OAEG;IACH,WAAW,EAAE,cAAc,CAAA;CAC5B;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,0CAA0C,oHAwBtD,CAAA"}
@@ -3,6 +3,29 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.validateDraftOrderShippingMethodActionStep = void 0;
4
4
  const utils_1 = require("@medusajs/framework/utils");
5
5
  const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
6
+ /**
7
+ * This step validates that a shipping method change can be removed from a draft order edit. It throws an error if the
8
+ * shipping method change is not in the draft order edit, or if the shipping method change is not adding a shipping method.
9
+ *
10
+ * :::note
11
+ *
12
+ * You can retrieve a draft order change's details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query),
13
+ * or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep).
14
+ *
15
+ * :::
16
+ *
17
+ * @example
18
+ * const data = validateDraftOrderShippingMethodActionStep({
19
+ * input: {
20
+ * action_id: "action_123",
21
+ * order_id: "order_123",
22
+ * },
23
+ * orderChange: {
24
+ * id: "orch_123",
25
+ * // other order change details...
26
+ * }
27
+ * })
28
+ */
6
29
  exports.validateDraftOrderShippingMethodActionStep = (0, workflows_sdk_1.createStep)("validate-draft-order-shipping-method-action", async function ({ input, orderChange, }) {
7
30
  const associatedAction = (orderChange.actions ?? []).find((a) => a.id === input.action_id);
8
31
  if (!associatedAction) {
@@ -1 +1 @@
1
- {"version":3,"file":"validate-draft-order-shipping-method-action.js","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-draft-order-shipping-method-action.ts"],"names":[],"mappings":";;;AAAA,qDAAyE;AACzE,qEAA8D;AAYjD,QAAA,0CAA0C,GAAG,IAAA,0BAAU,EAClE,6CAA6C,EAC7C,KAAK,WAAW,EACd,KAAK,EACL,WAAW,GACqC;IAChD,MAAM,gBAAgB,GAAG,CAAC,WAAW,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CACvD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,SAAS,CACR,CAAA;IAEzB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,MAAM,IAAI,mBAAW,CACnB,mBAAW,CAAC,KAAK,CAAC,YAAY,EAC9B,sCAAsC,KAAK,CAAC,QAAQ,oBAAoB,WAAW,CAAC,EAAE,EAAE,CACzF,CAAA;IACH,CAAC;IAED,IAAI,gBAAgB,CAAC,MAAM,KAAK,wBAAgB,CAAC,YAAY,EAAE,CAAC;QAC9D,MAAM,IAAI,mBAAW,CACnB,mBAAW,CAAC,KAAK,CAAC,YAAY,EAC9B,UAAU,gBAAgB,CAAC,EAAE,kCAAkC,CAChE,CAAA;IACH,CAAC;AACH,CAAC,CACF,CAAA"}
1
+ {"version":3,"file":"validate-draft-order-shipping-method-action.js","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-draft-order-shipping-method-action.ts"],"names":[],"mappings":";;;AAAA,qDAAyE;AACzE,qEAA8D;AAqB9D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACU,QAAA,0CAA0C,GAAG,IAAA,0BAAU,EAClE,6CAA6C,EAC7C,KAAK,WAAW,EACd,KAAK,EACL,WAAW,GACqC;IAChD,MAAM,gBAAgB,GAAG,CAAC,WAAW,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CACvD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,SAAS,CACR,CAAA;IAEzB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,MAAM,IAAI,mBAAW,CACnB,mBAAW,CAAC,KAAK,CAAC,YAAY,EAC9B,sCAAsC,KAAK,CAAC,QAAQ,oBAAoB,WAAW,CAAC,EAAE,EAAE,CACzF,CAAA;IACH,CAAC;IAED,IAAI,gBAAgB,CAAC,MAAM,KAAK,wBAAgB,CAAC,YAAY,EAAE,CAAC;QAC9D,MAAM,IAAI,mBAAW,CACnB,mBAAW,CAAC,KAAK,CAAC,YAAY,EAC9B,UAAU,gBAAgB,CAAC,EAAE,kCAAkC,CAChE,CAAA;IACH,CAAC;AACH,CAAC,CACF,CAAA"}
@@ -1,7 +1,39 @@
1
1
  import { OrderChangeDTO, OrderWorkflow } from "@medusajs/types";
2
+ /**
3
+ * The details of the draft order and its change to validate.
4
+ */
2
5
  export interface ValidateDraftOrderUpdateActionItemStepInput {
6
+ /**
7
+ * The details of updating a new item in a draft order edit.
8
+ */
3
9
  input: OrderWorkflow.UpdateOrderEditAddNewItemWorkflowInput;
10
+ /**
11
+ * The order change to validate.
12
+ */
4
13
  orderChange: OrderChangeDTO;
5
14
  }
15
+ /**
16
+ * This step validates that a new item can be updated in a draft order edit. It throws an error if the
17
+ * item change is not in the draft order edit, or if the item change is not adding an item.
18
+ *
19
+ * :::note
20
+ *
21
+ * You can retrieve a draft order change's details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query),
22
+ * or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep).
23
+ *
24
+ * :::
25
+ *
26
+ * @example
27
+ * const data = validateDraftOrderUpdateActionItemStep({
28
+ * input: {
29
+ * action_id: "action_123",
30
+ * order_id: "order_123",
31
+ * },
32
+ * orderChange: {
33
+ * id: "orch_123",
34
+ * // other order change details...
35
+ * }
36
+ * })
37
+ */
6
38
  export declare const validateDraftOrderUpdateActionItemStep: import("@medusajs/framework/workflows-sdk").StepFunction<ValidateDraftOrderUpdateActionItemStepInput, unknown>;
7
39
  //# sourceMappingURL=validate-draft-order-update-action-item.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"validate-draft-order-update-action-item.d.ts","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-draft-order-update-action-item.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/D,MAAM,WAAW,2CAA2C;IAC1D,KAAK,EAAE,aAAa,CAAC,sCAAsC,CAAA;IAC3D,WAAW,EAAE,cAAc,CAAA;CAC5B;AAED,eAAO,MAAM,sCAAsC,gHAwBlD,CAAA"}
1
+ {"version":3,"file":"validate-draft-order-update-action-item.d.ts","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-draft-order-update-action-item.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/D;;GAEG;AACH,MAAM,WAAW,2CAA2C;IAC1D;;OAEG;IACH,KAAK,EAAE,aAAa,CAAC,sCAAsC,CAAA;IAC3D;;OAEG;IACH,WAAW,EAAE,cAAc,CAAA;CAC5B;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,sCAAsC,gHAwBlD,CAAA"}
@@ -3,6 +3,29 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.validateDraftOrderUpdateActionItemStep = void 0;
4
4
  const utils_1 = require("@medusajs/framework/utils");
5
5
  const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
6
+ /**
7
+ * This step validates that a new item can be updated in a draft order edit. It throws an error if the
8
+ * item change is not in the draft order edit, or if the item change is not adding an item.
9
+ *
10
+ * :::note
11
+ *
12
+ * You can retrieve a draft order change's details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query),
13
+ * or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep).
14
+ *
15
+ * :::
16
+ *
17
+ * @example
18
+ * const data = validateDraftOrderUpdateActionItemStep({
19
+ * input: {
20
+ * action_id: "action_123",
21
+ * order_id: "order_123",
22
+ * },
23
+ * orderChange: {
24
+ * id: "orch_123",
25
+ * // other order change details...
26
+ * }
27
+ * })
28
+ */
6
29
  exports.validateDraftOrderUpdateActionItemStep = (0, workflows_sdk_1.createStep)("validate-draft-order-update-action-item", async function ({ input, orderChange, }) {
7
30
  const associatedAction = (orderChange.actions ?? []).find((a) => a.id === input.action_id);
8
31
  if (!associatedAction) {
@@ -1 +1 @@
1
- {"version":3,"file":"validate-draft-order-update-action-item.js","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-draft-order-update-action-item.ts"],"names":[],"mappings":";;;AAEA,qDAAyE;AACzE,qEAA8D;AAQjD,QAAA,sCAAsC,GAAG,IAAA,0BAAU,EAC9D,yCAAyC,EACzC,KAAK,WAAW,EACd,KAAK,EACL,WAAW,GACiC;IAC5C,MAAM,gBAAgB,GAAG,CAAC,WAAW,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CACvD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,SAAS,CACR,CAAA;IAEzB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,MAAM,IAAI,mBAAW,CACnB,mBAAW,CAAC,KAAK,CAAC,YAAY,EAC9B,oCAAoC,KAAK,CAAC,QAAQ,oBAAoB,WAAW,CAAC,EAAE,EAAE,CACvF,CAAA;IACH,CAAC;IAED,IAAI,gBAAgB,CAAC,MAAM,KAAK,wBAAgB,CAAC,QAAQ,EAAE,CAAC;QAC1D,MAAM,IAAI,mBAAW,CACnB,mBAAW,CAAC,KAAK,CAAC,YAAY,EAC9B,UAAU,gBAAgB,CAAC,EAAE,wBAAwB,CACtD,CAAA;IACH,CAAC;AACH,CAAC,CACF,CAAA"}
1
+ {"version":3,"file":"validate-draft-order-update-action-item.js","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-draft-order-update-action-item.ts"],"names":[],"mappings":";;;AAEA,qDAAyE;AACzE,qEAA8D;AAiB9D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACU,QAAA,sCAAsC,GAAG,IAAA,0BAAU,EAC9D,yCAAyC,EACzC,KAAK,WAAW,EACd,KAAK,EACL,WAAW,GACiC;IAC5C,MAAM,gBAAgB,GAAG,CAAC,WAAW,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CACvD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,SAAS,CACR,CAAA;IAEzB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,MAAM,IAAI,mBAAW,CACnB,mBAAW,CAAC,KAAK,CAAC,YAAY,EAC9B,oCAAoC,KAAK,CAAC,QAAQ,oBAAoB,WAAW,CAAC,EAAE,EAAE,CACvF,CAAA;IACH,CAAC;IAED,IAAI,gBAAgB,CAAC,MAAM,KAAK,wBAAgB,CAAC,QAAQ,EAAE,CAAC;QAC1D,MAAM,IAAI,mBAAW,CACnB,mBAAW,CAAC,KAAK,CAAC,YAAY,EAC9B,UAAU,gBAAgB,CAAC,EAAE,wBAAwB,CACtD,CAAA;IACH,CAAC;AACH,CAAC,CACF,CAAA"}
@@ -1,7 +1,30 @@
1
1
  import { OrderDTO } from "@medusajs/types";
2
- interface ValidateDraftOrderStepInput {
2
+ /**
3
+ * The details of the draft order to validate.
4
+ */
5
+ export interface ValidateDraftOrderStepInput {
6
+ /**
7
+ * The draft order to validate.
8
+ */
3
9
  order: OrderDTO;
4
10
  }
11
+ /**
12
+ * This step validates that an order is a draft order. It throws an error otherwise.
13
+ *
14
+ * :::note
15
+ *
16
+ * You can retrieve a draft order's details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query),
17
+ * or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep).
18
+ *
19
+ * :::
20
+ *
21
+ * @example
22
+ * const data = validateDraftOrderStep({
23
+ * order: {
24
+ * id: "order_123",
25
+ * // other order details...
26
+ * }
27
+ * })
28
+ */
5
29
  export declare const validateDraftOrderStep: import("@medusajs/framework/workflows-sdk").StepFunction<ValidateDraftOrderStepInput, unknown>;
6
- export {};
7
30
  //# sourceMappingURL=validate-draft-order.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"validate-draft-order.d.ts","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-draft-order.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAE1C,UAAU,2BAA2B;IACnC,KAAK,EAAE,QAAQ,CAAA;CAChB;AAED,eAAO,MAAM,sBAAsB,gGAUlC,CAAA"}
1
+ {"version":3,"file":"validate-draft-order.d.ts","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-draft-order.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAE1C;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAA;CAChB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,sBAAsB,gGAUlC,CAAA"}
@@ -3,6 +3,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.validateDraftOrderStep = void 0;
4
4
  const utils_1 = require("@medusajs/framework/utils");
5
5
  const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
6
+ /**
7
+ * This step validates that an order is a draft order. It throws an error otherwise.
8
+ *
9
+ * :::note
10
+ *
11
+ * You can retrieve a draft order's details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query),
12
+ * or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep).
13
+ *
14
+ * :::
15
+ *
16
+ * @example
17
+ * const data = validateDraftOrderStep({
18
+ * order: {
19
+ * id: "order_123",
20
+ * // other order details...
21
+ * }
22
+ * })
23
+ */
6
24
  exports.validateDraftOrderStep = (0, workflows_sdk_1.createStep)("validate-draft-order", async function ({ order }) {
7
25
  if (order.status !== utils_1.OrderStatus.DRAFT && !order.is_draft_order) {
8
26
  throw new utils_1.MedusaError(utils_1.MedusaError.Types.INVALID_DATA, `Order ${order.id} is not a draft order`);
@@ -1 +1 @@
1
- {"version":3,"file":"validate-draft-order.js","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-draft-order.ts"],"names":[],"mappings":";;;AAAA,qDAAoE;AACpE,qEAA8D;AAOjD,QAAA,sBAAsB,GAAG,IAAA,0BAAU,EAC9C,sBAAsB,EACtB,KAAK,WAAW,EAAE,KAAK,EAA+B;IACpD,IAAI,KAAK,CAAC,MAAM,KAAK,mBAAW,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC;QAChE,MAAM,IAAI,mBAAW,CACnB,mBAAW,CAAC,KAAK,CAAC,YAAY,EAC9B,SAAS,KAAK,CAAC,EAAE,uBAAuB,CACzC,CAAA;IACH,CAAC;AACH,CAAC,CACF,CAAA"}
1
+ {"version":3,"file":"validate-draft-order.js","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-draft-order.ts"],"names":[],"mappings":";;;AAAA,qDAAoE;AACpE,qEAA8D;AAa9D;;;;;;;;;;;;;;;;;GAiBG;AACU,QAAA,sBAAsB,GAAG,IAAA,0BAAU,EAC9C,sBAAsB,EACtB,KAAK,WAAW,EAAE,KAAK,EAA+B;IACpD,IAAI,KAAK,CAAC,MAAM,KAAK,mBAAW,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC;QAChE,MAAM,IAAI,mBAAW,CACnB,mBAAW,CAAC,KAAK,CAAC,YAAY,EAC9B,SAAS,KAAK,CAAC,EAAE,uBAAuB,CACzC,CAAA;IACH,CAAC;AACH,CAAC,CACF,CAAA"}
@@ -1,9 +1,40 @@
1
1
  import { PromotionDTO } from "@medusajs/types";
2
2
  export declare const validatePromoCodesToAddId = "validate-promo-codes-to-add";
3
- interface ValidatePromoCodesToAddStepInput {
3
+ /**
4
+ * The details of the promo codes to add to a draft order.
5
+ */
6
+ export interface ValidatePromoCodesToAddStepInput {
7
+ /**
8
+ * The promo codes to add to the draft order.
9
+ */
4
10
  promo_codes: string[];
11
+ /**
12
+ * The promotions to add to the draft order.
13
+ */
5
14
  promotions: PromotionDTO[];
6
15
  }
16
+ /**
17
+ * This step validates that the promo codes to add to a draft order are valid. It throws an error if the
18
+ * promo codes don't exist or are inactive.
19
+ *
20
+ * :::note
21
+ *
22
+ * You can retrieve a promotion's details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query),
23
+ * or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep).
24
+ *
25
+ * :::
26
+ *
27
+ * @example
28
+ * const data = validatePromoCodesToAddStep({
29
+ * promo_codes: ["PROMO_123", "PROMO_456"],
30
+ * promotions: [{
31
+ * id: "promo_123",
32
+ * code: "PROMO_123"
33
+ * }, {
34
+ * id: "promo_456",
35
+ * code: "PROMO_456"
36
+ * }],
37
+ * })
38
+ */
7
39
  export declare const validatePromoCodesToAddStep: import("@medusajs/framework/workflows-sdk").StepFunction<ValidatePromoCodesToAddStepInput, unknown>;
8
- export {};
9
40
  //# sourceMappingURL=validate-promo-codes-to-add.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"validate-promo-codes-to-add.d.ts","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-promo-codes-to-add.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAM9C,eAAO,MAAM,yBAAyB,gCAAgC,CAAA;AAEtE,UAAU,gCAAgC;IACxC,WAAW,EAAE,MAAM,EAAE,CAAA;IACrB,UAAU,EAAE,YAAY,EAAE,CAAA;CAC3B;AAED,eAAO,MAAM,2BAA2B,qGAQvC,CAAA"}
1
+ {"version":3,"file":"validate-promo-codes-to-add.d.ts","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-promo-codes-to-add.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAM9C,eAAO,MAAM,yBAAyB,gCAAgC,CAAA;AAEtE;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,WAAW,EAAE,MAAM,EAAE,CAAA;IACrB;;OAEG;IACH,UAAU,EAAE,YAAY,EAAE,CAAA;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,2BAA2B,qGAQvC,CAAA"}
@@ -4,6 +4,29 @@ exports.validatePromoCodesToAddStep = exports.validatePromoCodesToAddId = void 0
4
4
  const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
5
5
  const validation_1 = require("../utils/validation");
6
6
  exports.validatePromoCodesToAddId = "validate-promo-codes-to-add";
7
+ /**
8
+ * This step validates that the promo codes to add to a draft order are valid. It throws an error if the
9
+ * promo codes don't exist or are inactive.
10
+ *
11
+ * :::note
12
+ *
13
+ * You can retrieve a promotion's details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query),
14
+ * or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep).
15
+ *
16
+ * :::
17
+ *
18
+ * @example
19
+ * const data = validatePromoCodesToAddStep({
20
+ * promo_codes: ["PROMO_123", "PROMO_456"],
21
+ * promotions: [{
22
+ * id: "promo_123",
23
+ * code: "PROMO_123"
24
+ * }, {
25
+ * id: "promo_456",
26
+ * code: "PROMO_456"
27
+ * }],
28
+ * })
29
+ */
7
30
  exports.validatePromoCodesToAddStep = (0, workflows_sdk_1.createStep)(exports.validatePromoCodesToAddId, async function (input) {
8
31
  const { promo_codes, promotions } = input;
9
32
  (0, validation_1.throwIfCodesAreMissing)(promo_codes, promotions);
@@ -1 +1 @@
1
- {"version":3,"file":"validate-promo-codes-to-add.js","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-promo-codes-to-add.ts"],"names":[],"mappings":";;;AAAA,qEAA8D;AAE9D,oDAG4B;AAEf,QAAA,yBAAyB,GAAG,6BAA6B,CAAA;AAOzD,QAAA,2BAA2B,GAAG,IAAA,0BAAU,EACnD,iCAAyB,EACzB,KAAK,WAAW,KAAuC;IACrD,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,KAAK,CAAA;IAEzC,IAAA,mCAAsB,EAAC,WAAW,EAAE,UAAU,CAAC,CAAA;IAC/C,IAAA,oCAAuB,EAAC,WAAW,EAAE,UAAU,CAAC,CAAA;AAClD,CAAC,CACF,CAAA"}
1
+ {"version":3,"file":"validate-promo-codes-to-add.js","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-promo-codes-to-add.ts"],"names":[],"mappings":";;;AAAA,qEAA8D;AAE9D,oDAG4B;AAEf,QAAA,yBAAyB,GAAG,6BAA6B,CAAA;AAgBtE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACU,QAAA,2BAA2B,GAAG,IAAA,0BAAU,EACnD,iCAAyB,EACzB,KAAK,WAAW,KAAuC;IACrD,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,KAAK,CAAA;IAEzC,IAAA,mCAAsB,EAAC,WAAW,EAAE,UAAU,CAAC,CAAA;IAC/C,IAAA,oCAAuB,EAAC,WAAW,EAAE,UAAU,CAAC,CAAA;AAClD,CAAC,CACF,CAAA"}
@@ -1,9 +1,40 @@
1
1
  import { PromotionDTO } from "@medusajs/types";
2
2
  export declare const validatePromoCodesToRemoveId = "validate-promo-codes-to-remove";
3
- interface ValidatePromoCodesToRemoveStepInput {
3
+ /**
4
+ * The details of the promo codes removal to validate.
5
+ */
6
+ export interface ValidatePromoCodesToRemoveStepInput {
7
+ /**
8
+ * The promo codes to remove from the draft order.
9
+ */
4
10
  promo_codes: string[];
11
+ /**
12
+ * The promotions to remove from the draft order.
13
+ */
5
14
  promotions: PromotionDTO[];
6
15
  }
16
+ /**
17
+ * This step validates that the promo codes can be removed from a draft order. It throws an error if the promo
18
+ * codes don't exist.
19
+ *
20
+ * :::note
21
+ *
22
+ * You can retrieve a promotion's details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query),
23
+ * or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep).
24
+ *
25
+ * :::
26
+ *
27
+ * @example
28
+ * const data = validatePromoCodesToRemoveStep({
29
+ * promo_codes: ["PROMO_123", "PROMO_456"],
30
+ * promotions: [{
31
+ * id: "promo_123",
32
+ * code: "PROMO_123"
33
+ * }, {
34
+ * id: "promo_456",
35
+ * code: "PROMO_456"
36
+ * }],
37
+ * })
38
+ */
7
39
  export declare const validatePromoCodesToRemoveStep: import("@medusajs/framework/workflows-sdk").StepFunction<ValidatePromoCodesToRemoveStepInput, unknown>;
8
- export {};
9
40
  //# sourceMappingURL=validate-promo-codes-to-remove.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"validate-promo-codes-to-remove.d.ts","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-promo-codes-to-remove.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAG9C,eAAO,MAAM,4BAA4B,mCAAmC,CAAA;AAE5E,UAAU,mCAAmC;IAC3C,WAAW,EAAE,MAAM,EAAE,CAAA;IACrB,UAAU,EAAE,YAAY,EAAE,CAAA;CAC3B;AAED,eAAO,MAAM,8BAA8B,wGAO1C,CAAA"}
1
+ {"version":3,"file":"validate-promo-codes-to-remove.d.ts","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-promo-codes-to-remove.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAG9C,eAAO,MAAM,4BAA4B,mCAAmC,CAAA;AAE5E;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,WAAW,EAAE,MAAM,EAAE,CAAA;IACrB;;OAEG;IACH,UAAU,EAAE,YAAY,EAAE,CAAA;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,8BAA8B,wGAO1C,CAAA"}
@@ -4,6 +4,29 @@ exports.validatePromoCodesToRemoveStep = exports.validatePromoCodesToRemoveId =
4
4
  const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
5
5
  const validation_1 = require("../utils/validation");
6
6
  exports.validatePromoCodesToRemoveId = "validate-promo-codes-to-remove";
7
+ /**
8
+ * This step validates that the promo codes can be removed from a draft order. It throws an error if the promo
9
+ * codes don't exist.
10
+ *
11
+ * :::note
12
+ *
13
+ * You can retrieve a promotion's details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query),
14
+ * or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep).
15
+ *
16
+ * :::
17
+ *
18
+ * @example
19
+ * const data = validatePromoCodesToRemoveStep({
20
+ * promo_codes: ["PROMO_123", "PROMO_456"],
21
+ * promotions: [{
22
+ * id: "promo_123",
23
+ * code: "PROMO_123"
24
+ * }, {
25
+ * id: "promo_456",
26
+ * code: "PROMO_456"
27
+ * }],
28
+ * })
29
+ */
7
30
  exports.validatePromoCodesToRemoveStep = (0, workflows_sdk_1.createStep)(exports.validatePromoCodesToRemoveId, async function (input) {
8
31
  const { promo_codes, promotions } = input;
9
32
  (0, validation_1.throwIfCodesAreMissing)(promo_codes, promotions);
@@ -1 +1 @@
1
- {"version":3,"file":"validate-promo-codes-to-remove.js","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-promo-codes-to-remove.ts"],"names":[],"mappings":";;;AAAA,qEAA8D;AAE9D,oDAA4D;AAE/C,QAAA,4BAA4B,GAAG,gCAAgC,CAAA;AAO/D,QAAA,8BAA8B,GAAG,IAAA,0BAAU,EACtD,oCAA4B,EAC5B,KAAK,WAAW,KAA0C;IACxD,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,KAAK,CAAA;IAEzC,IAAA,mCAAsB,EAAC,WAAW,EAAE,UAAU,CAAC,CAAA;AACjD,CAAC,CACF,CAAA"}
1
+ {"version":3,"file":"validate-promo-codes-to-remove.js","sourceRoot":"","sources":["../../../src/draft-order/steps/validate-promo-codes-to-remove.ts"],"names":[],"mappings":";;;AAAA,qEAA8D;AAE9D,oDAA4D;AAE/C,QAAA,4BAA4B,GAAG,gCAAgC,CAAA;AAgB5E;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACU,QAAA,8BAA8B,GAAG,IAAA,0BAAU,EACtD,oCAA4B,EAC5B,KAAK,WAAW,KAA0C;IACxD,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,KAAK,CAAA;IAEzC,IAAA,mCAAsB,EAAC,WAAW,EAAE,UAAU,CAAC,CAAA;AACjD,CAAC,CACF,CAAA"}
@@ -1,4 +1,27 @@
1
1
  import { OrderWorkflow } from "@medusajs/types";
2
2
  export declare const addDraftOrderItemsWorkflowId = "add-draft-order-items";
3
+ /**
4
+ * This workflow adds items to a draft order. It's used by the
5
+ * [Add Item to Draft Order Admin API Route](https://docs.medusajs.com/api/admin#draft-orders_postdraftordersidedititems).
6
+ *
7
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around adding items to
8
+ * a draft order.
9
+ *
10
+ * @example
11
+ * const { result } = await addDraftOrderItemsWorkflow(container)
12
+ * .run({
13
+ * input: {
14
+ * order_id: "order_123",
15
+ * items: [{
16
+ * variant_id: "variant_123",
17
+ * quantity: 1
18
+ * }]
19
+ * }
20
+ * })
21
+ *
22
+ * @summary
23
+ *
24
+ * Add items to a draft order.
25
+ */
3
26
  export declare const addDraftOrderItemsWorkflow: import("@medusajs/framework/workflows-sdk").ReturnWorkflow<OrderWorkflow.OrderEditAddNewItemWorkflowInput, import("@medusajs/types").OrderPreviewDTO, []>;
4
27
  //# sourceMappingURL=add-draft-order-items.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"add-draft-order-items.d.ts","sourceRoot":"","sources":["../../../src/draft-order/workflows/add-draft-order-items.ts"],"names":[],"mappings":"AAYA,OAAO,EAA4B,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAYzE,eAAO,MAAM,4BAA4B,0BAA0B,CAAA;AAEnE,eAAO,MAAM,0BAA0B,2JAqGtC,CAAA"}
1
+ {"version":3,"file":"add-draft-order-items.d.ts","sourceRoot":"","sources":["../../../src/draft-order/workflows/add-draft-order-items.ts"],"names":[],"mappings":"AAYA,OAAO,EAA4B,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAYzE,eAAO,MAAM,4BAA4B,0BAA0B,CAAA;AAEnE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,0BAA0B,2JAqGtC,CAAA"}