From e4487341b6b7d378c178b309e6ab05a370511093 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Mon, 20 Jan 2025 11:11:37 +0200 Subject: [PATCH] chore(core-flows): general fixes to core-flows TSDocs (#11046) --- .../link-sales-channels-to-publishable-key.ts | 3 +++ .../workflows/create-return-fulfillment.ts | 4 +++ .../claim/remove-claim-item-action.ts | 4 +++ ...eate-or-update-order-payment-collection.ts | 4 +++ .../src/order/workflows/create-order.ts | 3 +-- .../order/workflows/return/cancel-return.ts | 4 +++ .../src/payment/workflows/refund-payments.ts | 20 ++++++++++++++- .../workflows/delete-price-lists.ts | 4 +++ .../workflows/batch-product-variants.ts | 4 +++ .../workflows/create-promotion-rules.ts | 4 +++ .../src/region/workflows/create-regions.ts | 4 +++ .../delete-reservations-by-line-items.ts | 25 ++++++++++++++++++- .../src/store/workflows/delete-stores.ts | 4 +++ 13 files changed, 83 insertions(+), 4 deletions(-) diff --git a/packages/core/core-flows/src/api-key/workflows/link-sales-channels-to-publishable-key.ts b/packages/core/core-flows/src/api-key/workflows/link-sales-channels-to-publishable-key.ts index 33ebaaee17..7e8a388a4f 100644 --- a/packages/core/core-flows/src/api-key/workflows/link-sales-channels-to-publishable-key.ts +++ b/packages/core/core-flows/src/api-key/workflows/link-sales-channels-to-publishable-key.ts @@ -32,6 +32,9 @@ export const linkSalesChannelsToApiKeyWorkflowId = * remove: ["sc_321"] * } * }) + * + * @summary + * Manage the sales channels of a publishable API key. */ export const linkSalesChannelsToApiKeyWorkflow = createWorkflow( linkSalesChannelsToApiKeyWorkflowId, diff --git a/packages/core/core-flows/src/fulfillment/workflows/create-return-fulfillment.ts b/packages/core/core-flows/src/fulfillment/workflows/create-return-fulfillment.ts index 8dbeda85f4..1a1bddb246 100644 --- a/packages/core/core-flows/src/fulfillment/workflows/create-return-fulfillment.ts +++ b/packages/core/core-flows/src/fulfillment/workflows/create-return-fulfillment.ts @@ -57,6 +57,10 @@ export const createReturnFulfillmentWorkflowId = * } * } * }) + * + * @summary + * + * Create a fulfillment for a return. */ export const createReturnFulfillmentWorkflow = createWorkflow( createReturnFulfillmentWorkflowId, diff --git a/packages/core/core-flows/src/order/workflows/claim/remove-claim-item-action.ts b/packages/core/core-flows/src/order/workflows/claim/remove-claim-item-action.ts index 83d5ebe8b7..48a4449a20 100644 --- a/packages/core/core-flows/src/order/workflows/claim/remove-claim-item-action.ts +++ b/packages/core/core-flows/src/order/workflows/claim/remove-claim-item-action.ts @@ -128,6 +128,10 @@ export const removeItemClaimActionWorkflowId = "remove-item-claim-action" * action_id: "orchact_123", * } * }) + * + * @summary + * + * Remove order items from a claim. */ export const removeItemClaimActionWorkflow = createWorkflow( removeItemClaimActionWorkflowId, diff --git a/packages/core/core-flows/src/order/workflows/create-or-update-order-payment-collection.ts b/packages/core/core-flows/src/order/workflows/create-or-update-order-payment-collection.ts index a74471bce2..a81f642dda 100644 --- a/packages/core/core-flows/src/order/workflows/create-or-update-order-payment-collection.ts +++ b/packages/core/core-flows/src/order/workflows/create-or-update-order-payment-collection.ts @@ -49,6 +49,10 @@ export const createOrUpdateOrderPaymentCollectionWorkflowId = * amount: 20 * } * }) + * + * @summary + * + * Create or update payment collection for an order. */ export const createOrUpdateOrderPaymentCollectionWorkflow = createWorkflow( createOrUpdateOrderPaymentCollectionWorkflowId, diff --git a/packages/core/core-flows/src/order/workflows/create-order.ts b/packages/core/core-flows/src/order/workflows/create-order.ts index 35ee351439..7cf7330848 100644 --- a/packages/core/core-flows/src/order/workflows/create-order.ts +++ b/packages/core/core-flows/src/order/workflows/create-order.ts @@ -228,7 +228,6 @@ export const createOrderWorkflow = createWorkflow( ) /** - * @deprecated - * Instead use the singular name "createOrderWorkflow" + * @deprecated Instead use the singular name `createOrderWorkflow`. */ export const createOrdersWorkflow = createOrderWorkflow diff --git a/packages/core/core-flows/src/order/workflows/return/cancel-return.ts b/packages/core/core-flows/src/order/workflows/return/cancel-return.ts index b7129c6bff..fbcff4e292 100644 --- a/packages/core/core-flows/src/order/workflows/return/cancel-return.ts +++ b/packages/core/core-flows/src/order/workflows/return/cancel-return.ts @@ -105,6 +105,10 @@ export const cancelReturnWorkflowId = "cancel-return" * return_id: "return_123", * } * }) + * + * @summary + * + * Cancel a return. */ export const cancelReturnWorkflow = createWorkflow( cancelReturnWorkflowId, diff --git a/packages/core/core-flows/src/payment/workflows/refund-payments.ts b/packages/core/core-flows/src/payment/workflows/refund-payments.ts index c275569375..e9e73f49cf 100644 --- a/packages/core/core-flows/src/payment/workflows/refund-payments.ts +++ b/packages/core/core-flows/src/payment/workflows/refund-payments.ts @@ -105,7 +105,25 @@ export type RefundPaymentsWorkflowInput = { export const refundPaymentsWorkflowId = "refund-payments-workflow" /** - * This workflow refunds a payment. + * This workflow refunds payments. + * + * You can use this workflow within your customizations or your own custom workflows, allowing you to + * refund payments in your custom flow. + * + * @example + * const { result } = await refundPaymentsWorkflow(container) + * .run({ + * input: [ + * { + * payment_id: "pay_123", + * amount: 10, + * } + * ] + * }) + * + * @summary + * + * Refund one or more payments. */ export const refundPaymentsWorkflow = createWorkflow( refundPaymentsWorkflowId, diff --git a/packages/core/core-flows/src/price-list/workflows/delete-price-lists.ts b/packages/core/core-flows/src/price-list/workflows/delete-price-lists.ts index f73f20efac..cddae1ff7b 100644 --- a/packages/core/core-flows/src/price-list/workflows/delete-price-lists.ts +++ b/packages/core/core-flows/src/price-list/workflows/delete-price-lists.ts @@ -26,6 +26,10 @@ export const deletePriceListsWorkflowId = "delete-price-lists" * ids: ["plist_123"] * } * }) + * + * @summary + * + * Delete one or more price lists. */ export const deletePriceListsWorkflow = createWorkflow( deletePriceListsWorkflowId, diff --git a/packages/core/core-flows/src/product/workflows/batch-product-variants.ts b/packages/core/core-flows/src/product/workflows/batch-product-variants.ts index 7aff253522..cd5c648243 100644 --- a/packages/core/core-flows/src/product/workflows/batch-product-variants.ts +++ b/packages/core/core-flows/src/product/workflows/batch-product-variants.ts @@ -65,6 +65,10 @@ export const batchProductVariantsWorkflowId = "batch-product-variants" * delete: ["variant_321"] * } * }) + * + * @summary + * + * Create, update, and delete product variants. */ export const batchProductVariantsWorkflow = createWorkflow( batchProductVariantsWorkflowId, diff --git a/packages/core/core-flows/src/promotion/workflows/create-promotion-rules.ts b/packages/core/core-flows/src/promotion/workflows/create-promotion-rules.ts index 817c0943fe..ddbcd03233 100644 --- a/packages/core/core-flows/src/promotion/workflows/create-promotion-rules.ts +++ b/packages/core/core-flows/src/promotion/workflows/create-promotion-rules.ts @@ -35,6 +35,10 @@ export const createPromotionRulesWorkflowId = "create-promotion-rules-workflow" * } * } * }) + * + * @summary + * + * Create one or more promotion rules. */ export const createPromotionRulesWorkflow = createWorkflow( createPromotionRulesWorkflowId, diff --git a/packages/core/core-flows/src/region/workflows/create-regions.ts b/packages/core/core-flows/src/region/workflows/create-regions.ts index 7f97855aee..51b320c0a9 100644 --- a/packages/core/core-flows/src/region/workflows/create-regions.ts +++ b/packages/core/core-flows/src/region/workflows/create-regions.ts @@ -33,6 +33,10 @@ export const createRegionsWorkflowId = "create-regions" * ] * } * }) + * + * @summary + * + * Create one or more regions. */ export const createRegionsWorkflow = createWorkflow( createRegionsWorkflowId, diff --git a/packages/core/core-flows/src/reservation/workflows/delete-reservations-by-line-items.ts b/packages/core/core-flows/src/reservation/workflows/delete-reservations-by-line-items.ts index c6a7bc15a3..ada0bdb18f 100644 --- a/packages/core/core-flows/src/reservation/workflows/delete-reservations-by-line-items.ts +++ b/packages/core/core-flows/src/reservation/workflows/delete-reservations-by-line-items.ts @@ -2,12 +2,35 @@ import { WorkflowData, createWorkflow } from "@medusajs/framework/workflows-sdk" import { deleteReservationsByLineItemsStep } from "../steps" -export type DeleteReservationByLineItemsWorkflowInput = { ids: string[] } +/** + * The data to delete reservations by their associated line items. + */ +export type DeleteReservationByLineItemsWorkflowInput = { + /** + * The IDs of the line items to delete reservations for. + */ + ids: string[] +} export const deleteReservationsByLineItemsWorkflowId = "delete-reservations-by-line-items" /** * This workflow deletes reservations by their associated line items. + * + * You can use this workflow within your own customizations or custom workflows, allowing you + * to delete reservations by their associated line items within your custom flows. + * + * @example + * const { result } = await deleteReservationsByLineItemsWorkflow(container) + * .run({ + * input: { + * ids: ["orli_123"] + * } + * }) + * + * @summary + * + * Delete reservations by their associated line items. */ export const deleteReservationsByLineItemsWorkflow = createWorkflow( deleteReservationsByLineItemsWorkflowId, diff --git a/packages/core/core-flows/src/store/workflows/delete-stores.ts b/packages/core/core-flows/src/store/workflows/delete-stores.ts index 96527cbc60..559ecd401e 100644 --- a/packages/core/core-flows/src/store/workflows/delete-stores.ts +++ b/packages/core/core-flows/src/store/workflows/delete-stores.ts @@ -33,6 +33,10 @@ export const deleteStoresWorkflowId = "delete-stores" * ids: ["store_123"] * } * }) + * + * @summary + * + * Delete one or more stores. */ export const deleteStoresWorkflow = createWorkflow( deleteStoresWorkflowId,