diff --git a/packages/core/core-flows/src/product/steps/batch-link-products-collection.ts b/packages/core/core-flows/src/product/steps/batch-link-products-collection.ts index f4b396b8d6..0d84c30667 100644 --- a/packages/core/core-flows/src/product/steps/batch-link-products-collection.ts +++ b/packages/core/core-flows/src/product/steps/batch-link-products-collection.ts @@ -4,6 +4,9 @@ import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const batchLinkProductsToCollectionStepId = "batch-link-products-to-collection" +/** + * This step creates links between product and collection records. + */ export const batchLinkProductsToCollectionStep = createStep( batchLinkProductsToCollectionStepId, async (data: LinkWorkflowInput, { container }) => { diff --git a/packages/core/core-flows/src/product/steps/batch-link-products-in-category.ts b/packages/core/core-flows/src/product/steps/batch-link-products-in-category.ts index f4a385d525..bc1f357b36 100644 --- a/packages/core/core-flows/src/product/steps/batch-link-products-in-category.ts +++ b/packages/core/core-flows/src/product/steps/batch-link-products-in-category.ts @@ -4,6 +4,9 @@ import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const batchLinkProductsToCategoryStepId = "batch-link-products-to-category" +/** + * This step creates links between product and category records. + */ export const batchLinkProductsToCategoryStep = createStep( batchLinkProductsToCategoryStepId, async ( diff --git a/packages/core/core-flows/src/product/steps/create-collections.ts b/packages/core/core-flows/src/product/steps/create-collections.ts index 6ea67c2de9..6487eb119e 100644 --- a/packages/core/core-flows/src/product/steps/create-collections.ts +++ b/packages/core/core-flows/src/product/steps/create-collections.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const createCollectionsStepId = "create-collections" +/** + * This step creates one or more collection. + */ export const createCollectionsStep = createStep( createCollectionsStepId, async (data: ProductTypes.CreateProductCollectionDTO[], { container }) => { diff --git a/packages/core/core-flows/src/product/steps/create-product-options.ts b/packages/core/core-flows/src/product/steps/create-product-options.ts index 3832959e05..94c1c2ce49 100644 --- a/packages/core/core-flows/src/product/steps/create-product-options.ts +++ b/packages/core/core-flows/src/product/steps/create-product-options.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const createProductOptionsStepId = "create-product-options" +/** + * This step creates one or more product options. + */ export const createProductOptionsStep = createStep( createProductOptionsStepId, async (data: ProductTypes.CreateProductOptionDTO[], { container }) => { diff --git a/packages/core/core-flows/src/product/steps/create-product-tags.ts b/packages/core/core-flows/src/product/steps/create-product-tags.ts index 9bbe3d097b..ef50eed124 100644 --- a/packages/core/core-flows/src/product/steps/create-product-tags.ts +++ b/packages/core/core-flows/src/product/steps/create-product-tags.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const createProductTagsStepId = "create-product-tags" +/** + * This step creates one or more product tags. + */ export const createProductTagsStep = createStep( createProductTagsStepId, async (data: ProductTypes.CreateProductTagDTO[], { container }) => { diff --git a/packages/core/core-flows/src/product/steps/create-product-types.ts b/packages/core/core-flows/src/product/steps/create-product-types.ts index d18e5337b0..8e599c9c79 100644 --- a/packages/core/core-flows/src/product/steps/create-product-types.ts +++ b/packages/core/core-flows/src/product/steps/create-product-types.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const createProductTypesStepId = "create-product-types" +/** + * This step creates one or more product types. + */ export const createProductTypesStep = createStep( createProductTypesStepId, async (data: ProductTypes.CreateProductTypeDTO[], { container }) => { diff --git a/packages/core/core-flows/src/product/steps/create-product-variants.ts b/packages/core/core-flows/src/product/steps/create-product-variants.ts index edeb5a1157..2949e193eb 100644 --- a/packages/core/core-flows/src/product/steps/create-product-variants.ts +++ b/packages/core/core-flows/src/product/steps/create-product-variants.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const createProductVariantsStepId = "create-product-variants" +/** + * This step creates one or more product variants. + */ export const createProductVariantsStep = createStep( createProductVariantsStepId, async (data: ProductTypes.CreateProductVariantDTO[], { container }) => { diff --git a/packages/core/core-flows/src/product/steps/create-products.ts b/packages/core/core-flows/src/product/steps/create-products.ts index 13a8ed5839..444a55d4db 100644 --- a/packages/core/core-flows/src/product/steps/create-products.ts +++ b/packages/core/core-flows/src/product/steps/create-products.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const createProductsStepId = "create-products" +/** + * This step creates one or more products. + */ export const createProductsStep = createStep( createProductsStepId, async (data: ProductTypes.CreateProductDTO[], { container }) => { diff --git a/packages/core/core-flows/src/product/steps/create-variant-pricing-link.ts b/packages/core/core-flows/src/product/steps/create-variant-pricing-link.ts index cde73f9e8c..93e65b2f41 100644 --- a/packages/core/core-flows/src/product/steps/create-variant-pricing-link.ts +++ b/packages/core/core-flows/src/product/steps/create-variant-pricing-link.ts @@ -1,7 +1,7 @@ import { ContainerRegistrationKeys, Modules } from "@medusajs/utils" import { createStep, StepResponse } from "@medusajs/workflows-sdk" -type StepInput = { +export type CreateVariantPricingLinkStepInput = { links: { variant_id: string price_set_id: string @@ -9,9 +9,12 @@ type StepInput = { } export const createVariantPricingLinkStepId = "create-variant-pricing-link" +/** + * This step creates links between variant and price set records. + */ export const createVariantPricingLinkStep = createStep( createVariantPricingLinkStepId, - async (data: StepInput, { container }) => { + async (data: CreateVariantPricingLinkStepInput, { container }) => { const remoteLink = container.resolve(ContainerRegistrationKeys.REMOTE_LINK) await remoteLink.create( data.links.map((entry) => ({ diff --git a/packages/core/core-flows/src/product/steps/delete-collections.ts b/packages/core/core-flows/src/product/steps/delete-collections.ts index 773dde2b3f..c9dcd1448a 100644 --- a/packages/core/core-flows/src/product/steps/delete-collections.ts +++ b/packages/core/core-flows/src/product/steps/delete-collections.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const deleteCollectionsStepId = "delete-collections" +/** + * This step deletes one or more collections. + */ export const deleteCollectionsStep = createStep( deleteCollectionsStepId, async (ids: string[], { container }) => { diff --git a/packages/core/core-flows/src/product/steps/delete-product-options.ts b/packages/core/core-flows/src/product/steps/delete-product-options.ts index 0817dd48f8..67007b560a 100644 --- a/packages/core/core-flows/src/product/steps/delete-product-options.ts +++ b/packages/core/core-flows/src/product/steps/delete-product-options.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const deleteProductOptionsStepId = "delete-product-options" +/** + * This step deletes one or more product options. + */ export const deleteProductOptionsStep = createStep( deleteProductOptionsStepId, async (ids: string[], { container }) => { diff --git a/packages/core/core-flows/src/product/steps/delete-product-tags.ts b/packages/core/core-flows/src/product/steps/delete-product-tags.ts index 651914fa7a..e1e224e287 100644 --- a/packages/core/core-flows/src/product/steps/delete-product-tags.ts +++ b/packages/core/core-flows/src/product/steps/delete-product-tags.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const deleteProductTagsStepId = "delete-product-tags" +/** + * This step deletes one or more product tags. + */ export const deleteProductTagsStep = createStep( deleteProductTagsStepId, async (ids: string[], { container }) => { diff --git a/packages/core/core-flows/src/product/steps/delete-product-types.ts b/packages/core/core-flows/src/product/steps/delete-product-types.ts index 42e73030d9..04eb92b84b 100644 --- a/packages/core/core-flows/src/product/steps/delete-product-types.ts +++ b/packages/core/core-flows/src/product/steps/delete-product-types.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const deleteProductTypesStepId = "delete-product-types" +/** + * This step deletes one or more product types. + */ export const deleteProductTypesStep = createStep( deleteProductTypesStepId, async (ids: string[], { container }) => { diff --git a/packages/core/core-flows/src/product/steps/delete-product-variants.ts b/packages/core/core-flows/src/product/steps/delete-product-variants.ts index ebcae16812..194d061810 100644 --- a/packages/core/core-flows/src/product/steps/delete-product-variants.ts +++ b/packages/core/core-flows/src/product/steps/delete-product-variants.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const deleteProductVariantsStepId = "delete-product-variants" +/** + * This step deletes one or more product variants. + */ export const deleteProductVariantsStep = createStep( deleteProductVariantsStepId, async (ids: string[], { container }) => { diff --git a/packages/core/core-flows/src/product/steps/delete-products.ts b/packages/core/core-flows/src/product/steps/delete-products.ts index adf7b9da5f..783a419730 100644 --- a/packages/core/core-flows/src/product/steps/delete-products.ts +++ b/packages/core/core-flows/src/product/steps/delete-products.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const deleteProductsStepId = "delete-products" +/** + * This step deletes one or more products. + */ export const deleteProductsStep = createStep( deleteProductsStepId, async (ids: string[], { container }) => { diff --git a/packages/core/core-flows/src/product/steps/generate-product-csv.ts b/packages/core/core-flows/src/product/steps/generate-product-csv.ts index ad5078fbe6..c95b560a4d 100644 --- a/packages/core/core-flows/src/product/steps/generate-product-csv.ts +++ b/packages/core/core-flows/src/product/steps/generate-product-csv.ts @@ -58,6 +58,9 @@ const csvSortFunction = (a: string, b: string) => { } export const generateProductCsvStepId = "generate-product-csv" +/** + * This step generates a CSV file to be exported. + */ export const generateProductCsvStep = createStep( generateProductCsvStepId, async (products: HttpTypes.AdminProduct[], { container }) => { diff --git a/packages/core/core-flows/src/product/steps/get-all-products.ts b/packages/core/core-flows/src/product/steps/get-all-products.ts index e7f88fb0f7..8bc491bb23 100644 --- a/packages/core/core-flows/src/product/steps/get-all-products.ts +++ b/packages/core/core-flows/src/product/steps/get-all-products.ts @@ -5,15 +5,18 @@ import { } from "@medusajs/utils" import { createStep, StepResponse } from "@medusajs/workflows-sdk" -type StepInput = { +export type GetAllProductsStepInput = { select: string[] filter?: FilterableProductProps } export const getAllProductsStepId = "get-all-products" +/** + * This step retrieves all products. + */ export const getAllProductsStep = createStep( getAllProductsStepId, - async (data: StepInput, { container }) => { + async (data: GetAllProductsStepInput, { container }) => { const remoteQuery: RemoteQueryFunction = container.resolve( ContainerRegistrationKeys.REMOTE_QUERY ) diff --git a/packages/core/core-flows/src/product/steps/get-products.ts b/packages/core/core-flows/src/product/steps/get-products.ts index 71386c5171..1c6825933d 100644 --- a/packages/core/core-flows/src/product/steps/get-products.ts +++ b/packages/core/core-flows/src/product/steps/get-products.ts @@ -2,14 +2,17 @@ import { IProductModuleService } from "@medusajs/types" import { ModuleRegistrationName } from "@medusajs/utils" import { createStep, StepResponse } from "@medusajs/workflows-sdk" -type StepInput = { +export type GetProductsStepInput = { ids?: string[] } export const getProductsStepId = "get-products" +/** + * This step retrieves products. + */ export const getProductsStep = createStep( getProductsStepId, - async (data: StepInput, { container }) => { + async (data: GetProductsStepInput, { container }) => { const service = container.resolve( ModuleRegistrationName.PRODUCT ) diff --git a/packages/core/core-flows/src/product/steps/get-variant-pricing-link.ts b/packages/core/core-flows/src/product/steps/get-variant-pricing-link.ts index f3046c385e..96805d21fe 100644 --- a/packages/core/core-flows/src/product/steps/get-variant-pricing-link.ts +++ b/packages/core/core-flows/src/product/steps/get-variant-pricing-link.ts @@ -6,14 +6,17 @@ import { } from "@medusajs/utils" import { createStep, StepResponse } from "@medusajs/workflows-sdk" -type StepInput = { +export type GetVariantPricingLinkStepInput = { ids: string[] } export const getVariantPricingLinkStepId = "get-variant-pricing-link" +/** + * This step retrieves links between a product variant and its linked price sets. + */ export const getVariantPricingLinkStep = createStep( getVariantPricingLinkStepId, - async (data: StepInput, { container }) => { + async (data: GetVariantPricingLinkStepInput, { container }) => { if (!data.ids.length) { return new StepResponse([]) } diff --git a/packages/core/core-flows/src/product/steps/group-products-for-batch.ts b/packages/core/core-flows/src/product/steps/group-products-for-batch.ts index 614a642dcc..f757b4f971 100644 --- a/packages/core/core-flows/src/product/steps/group-products-for-batch.ts +++ b/packages/core/core-flows/src/product/steps/group-products-for-batch.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const groupProductsForBatchStepId = "group-products-for-batch" +/** + * This step groups products to be created and updated. + */ export const groupProductsForBatchStep = createStep( groupProductsForBatchStepId, async ( diff --git a/packages/core/core-flows/src/product/steps/parse-product-csv.ts b/packages/core/core-flows/src/product/steps/parse-product-csv.ts index f2125d78ba..da392433ea 100644 --- a/packages/core/core-flows/src/product/steps/parse-product-csv.ts +++ b/packages/core/core-flows/src/product/steps/parse-product-csv.ts @@ -13,6 +13,9 @@ import { import { normalizeV1Products } from "../helpers/normalize-v1-import" export const parseProductCsvStepId = "parse-product-csv" +/** + * This step parses a CSV file holding products to import. + */ export const parseProductCsvStep = createStep( parseProductCsvStepId, async (fileContent: string, { container }) => { diff --git a/packages/core/core-flows/src/product/steps/update-collections.ts b/packages/core/core-flows/src/product/steps/update-collections.ts index 183a819dff..0d80e8d3e1 100644 --- a/packages/core/core-flows/src/product/steps/update-collections.ts +++ b/packages/core/core-flows/src/product/steps/update-collections.ts @@ -5,12 +5,15 @@ import { } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" -type UpdateCollectionsStepInput = { +export type UpdateCollectionsStepInput = { selector: ProductTypes.FilterableProductCollectionProps update: ProductTypes.UpdateProductCollectionDTO } export const updateCollectionsStepId = "update-collections" +/** + * This step updates collections matching the specified filters. + */ export const updateCollectionsStep = createStep( updateCollectionsStepId, async (data: UpdateCollectionsStepInput, { container }) => { diff --git a/packages/core/core-flows/src/product/steps/update-product-options.ts b/packages/core/core-flows/src/product/steps/update-product-options.ts index 0227a492a3..8d4af9a6f6 100644 --- a/packages/core/core-flows/src/product/steps/update-product-options.ts +++ b/packages/core/core-flows/src/product/steps/update-product-options.ts @@ -5,12 +5,15 @@ import { } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" -type UpdateProductOptionsStepInput = { +export type UpdateProductOptionsStepInput = { selector: ProductTypes.FilterableProductOptionProps update: ProductTypes.UpdateProductOptionDTO } export const updateProductOptionsStepId = "update-product-options" +/** + * This step updates product options matching the specified filters. + */ export const updateProductOptionsStep = createStep( updateProductOptionsStepId, async (data: UpdateProductOptionsStepInput, { container }) => { diff --git a/packages/core/core-flows/src/product/steps/update-product-tags.ts b/packages/core/core-flows/src/product/steps/update-product-tags.ts index 4ec3365602..94ce882d54 100644 --- a/packages/core/core-flows/src/product/steps/update-product-tags.ts +++ b/packages/core/core-flows/src/product/steps/update-product-tags.ts @@ -5,12 +5,15 @@ import { } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" -type UpdateProductTagsStepInput = { +export type UpdateProductTagsStepInput = { selector: ProductTypes.FilterableProductTagProps update: ProductTypes.UpdateProductTagDTO } export const updateProductTagsStepId = "update-product-tags" +/** + * This step updates product tags matching the specified filters. + */ export const updateProductTagsStep = createStep( updateProductTagsStepId, async (data: UpdateProductTagsStepInput, { container }) => { diff --git a/packages/core/core-flows/src/product/steps/update-product-types.ts b/packages/core/core-flows/src/product/steps/update-product-types.ts index 31ef644849..47e6384cbe 100644 --- a/packages/core/core-flows/src/product/steps/update-product-types.ts +++ b/packages/core/core-flows/src/product/steps/update-product-types.ts @@ -5,12 +5,15 @@ import { } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" -type UpdateProductTypesStepInput = { +export type UpdateProductTypesStepInput = { selector: ProductTypes.FilterableProductTypeProps update: ProductTypes.UpdateProductTypeDTO } export const updateProductTypesStepId = "update-product-types" +/** + * This step updates product types matching the specified filters. + */ export const updateProductTypesStep = createStep( updateProductTypesStepId, async (data: UpdateProductTypesStepInput, { container }) => { diff --git a/packages/core/core-flows/src/product/steps/update-product-variants.ts b/packages/core/core-flows/src/product/steps/update-product-variants.ts index 10b11d54dd..b8280e4dea 100644 --- a/packages/core/core-flows/src/product/steps/update-product-variants.ts +++ b/packages/core/core-flows/src/product/steps/update-product-variants.ts @@ -6,7 +6,7 @@ import { } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" -type UpdateProductVariantsStepInput = +export type UpdateProductVariantsStepInput = | { selector: ProductTypes.FilterableProductVariantProps update: ProductTypes.UpdateProductVariantDTO @@ -16,6 +16,9 @@ type UpdateProductVariantsStepInput = } export const updateProductVariantsStepId = "update-product-variants" +/** + * This step updates one or more product variants. + */ export const updateProductVariantsStep = createStep( updateProductVariantsStepId, async (data: UpdateProductVariantsStepInput, { container }) => { diff --git a/packages/core/core-flows/src/product/steps/update-products.ts b/packages/core/core-flows/src/product/steps/update-products.ts index f45bbc3c00..a9ed92d011 100644 --- a/packages/core/core-flows/src/product/steps/update-products.ts +++ b/packages/core/core-flows/src/product/steps/update-products.ts @@ -16,6 +16,9 @@ export type UpdateProductsStepInput = } export const updateProductsStepId = "update-products" +/** + * This step updates one or more products. + */ export const updateProductsStep = createStep( updateProductsStepId, async (data: UpdateProductsStepInput, { container }) => { diff --git a/packages/core/core-flows/src/product/steps/wait-confirmation-product-import.ts b/packages/core/core-flows/src/product/steps/wait-confirmation-product-import.ts index 0032c0eab9..fb9f6ba75c 100644 --- a/packages/core/core-flows/src/product/steps/wait-confirmation-product-import.ts +++ b/packages/core/core-flows/src/product/steps/wait-confirmation-product-import.ts @@ -2,6 +2,9 @@ import { createStep } from "@medusajs/workflows-sdk" export const waitConfirmationProductImportStepId = "wait-confirmation-product-import" +/** + * This step waits until a product import is confirmed. + */ export const waitConfirmationProductImportStep = createStep( { name: waitConfirmationProductImportStepId,