docs: add TSDocs for d9af2f5 (#15065)

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>

Author: shahednasser

packages/core/core-flows/src/draft-order/workflows/compute-draft-order-adjustments.ts

@@ -24,6 +24,9 @@ import { acquireLockStep, releaseLockStep } from "../../locking"
 import { deleteOrderChangeActionsStep } from "../../order/steps/delete-order-change-actions"
 import { prepareOrderComputeActionContextStep } from "../../order/workflows/order-edit/utils/prepare-order-compute-action-context"
 
+/**
+ * The ID of the compute draft order adjustments workflow.
+ */
 export const computeDraftOrderAdjustmentsWorkflowId =
   "compute-draft-order-adjustments"
 

packages/core/core-flows/src/order/workflows/compute-adjustments-for-preview.ts

@@ -41,6 +41,9 @@ export type ComputeAdjustmentsForPreviewWorkflowInput = {
   orderChange: OrderChangeDTO
 }
 
+/**
+ * The ID of the compute adjustments for preview workflow.
+ */
 export const computeAdjustmentsForPreviewWorkflowId =
   "compute-adjustments-for-preview"
 /**

packages/core/types/src/order/common.ts

@@ -31,8 +31,16 @@ export type ChangeActionType =
   | "PROMOTION_ADD"
   | "PROMOTION_REMOVE"
   | "ITEM_ADJUSTMENTS_REPLACE"
-  | "SHIPPING_ADJUSTMENTS_REPLACE"
+  | /**
+   * Replace shipping method adjustments.
+   *
+   * @since 2.13.7
+   */
+  "SHIPPING_ADJUSTMENTS_REPLACE"
 
+/**
+ * The order change's status.
+ */
 export type OrderChangeStatus =
   | "confirmed"
   | "declined"
@@ -134,6 +142,8 @@ export interface OrderShippingMethodAdjustmentDTO
 
   /**
    * The version of the adjustment.
+   *
+   * @since 2.13.7
    */
   version: number
 }
@@ -156,6 +166,8 @@ export interface OrderLineItemAdjustmentDTO extends OrderAdjustmentLineDTO {
 
   /**
    * The version of the adjustment.
+   *
+   * @since 2.13.7
    */
   version: number
 }

packages/core/types/src/order/mutations.ts

@@ -843,6 +843,8 @@ export interface CreateOrderShippingMethodAdjustmentDTO {
 
   /**
    * The version of the adjustment.
+   *
+   * @since 2.13.7
    */
   version?: number
 }

packages/modules/order/src/models/shipping-method-adjustment.ts

@@ -37,4 +37,10 @@ const _OrderShippingMethodAdjustment = model
     },
   ])
 
+/**
+ * The Order Shipping Method Adjustment data model. This model represents adjustments applied to 
+ * order shipping methods, such as promotions or discounts.
+ *
+ * @since 2.13.7
+ */
 export const OrderShippingMethodAdjustment = _OrderShippingMethodAdjustment