chore(core-flows,types): fix links in TSDocs pointing to architectural modules (#12213)

This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-04-17 15:01:28 +03:00
1 parent 9d27c0c194
commit 1c5e82af51
8 files changed
+11 -11

No files matched your search

@@ -10,7 +10,7 @@ export type DeleteFilesStepInput = string[]
export const deleteFilesStepId = "delete-files" export const deleteFilesStepId = "delete-files"
/** /**
* This step deletes one or more files using the installed * This step deletes one or more files using the installed
* [File Module Provider](https://docs.medusajs.com/resources/architectural-modules/file). The files * [File Module Provider](https://docs.medusajs.com/resources/infrastructure-modules/file). The files
* will be removed from the database and the storage. * will be removed from the database and the storage.
* *
* @example * @example
@@ -40,7 +40,7 @@ export type UploadFilesStepInput = {
export const uploadFilesStepId = "upload-files" export const uploadFilesStepId = "upload-files"
/** /**
* This step uploads one or more files using the installed * This step uploads one or more files using the installed
* [File Module Provider](https://docs.medusajs.com/resources/architectural-modules/file). * [File Module Provider](https://docs.medusajs.com/resources/infrastructure-modules/file).
* *
* @example * @example
* const data = uploadFilesStep({ * const data = uploadFilesStep({
@@ -8,7 +8,7 @@ export const deleteFilesWorkflowId = "delete-files"
* This workflow deletes one or more files. It's used by the * This workflow deletes one or more files. It's used by the
* [Delete File Upload Admin API Route](https://docs.medusajs.com/api/admin#uploads_deleteuploadsid). * [Delete File Upload Admin API Route](https://docs.medusajs.com/api/admin#uploads_deleteuploadsid).
* *
* The [File Module Provider](https://docs.medusajs.com/resources/architectural-modules/file) installed * The [File Module Provider](https://docs.medusajs.com/resources/infrastructure-modules/file) installed
* in your application will be used to delete the file from storage. * in your application will be used to delete the file from storage.
* *
* You can use this workflow within your customizations or your own custom workflows, allowing you to * You can use this workflow within your customizations or your own custom workflows, allowing you to
@@ -44,7 +44,7 @@ export type UploadFilesWorkflowInput = {
export const uploadFilesWorkflowId = "upload-files" export const uploadFilesWorkflowId = "upload-files"
/** /**
* This workflow uploads one or more files using the installed * This workflow uploads one or more files using the installed
* [File Module Provider](https://docs.medusajs.com/resources/architectural-modules/file). The workflow is used by the * [File Module Provider](https://docs.medusajs.com/resources/infrastructure-modules/file). The workflow is used by the
* [Upload Files Admin API Route](https://docs.medusajs.com/api/admin#uploads_postuploads). * [Upload Files Admin API Route](https://docs.medusajs.com/api/admin#uploads_postuploads).
* *
* You can use this workflow within your customizations or your own custom workflows, allowing you to * You can use this workflow within your customizations or your own custom workflows, allowing you to
@@ -13,7 +13,7 @@ export type NotifyOnFailureStepInput = {
to: string to: string
/** /**
* The channel to send the notification through. For example, `email`. * The channel to send the notification through. For example, `email`.
* A [Notification Module Provider](https://docs.medusajs.com/resources/architectural-modules/notification) * A [Notification Module Provider](https://docs.medusajs.com/resources/infrastructure-modules/notification)
* must be installed and configured for the specified channel. * must be installed and configured for the specified channel.
*/ */
channel: string channel: string
@@ -68,11 +68,11 @@ export type GenerateProductCsvStepInput = HttpTypes.AdminProduct[]
*/ */
export type GenerateProductCsvStepOutput = { export type GenerateProductCsvStepOutput = {
/** /**
* The ID of the generated file as returned by the [File Module Provider](https://docs.medusajs.com/resources/architectural-modules/file). * The ID of the generated file as returned by the [File Module Provider](https://docs.medusajs.com/resources/infrastructure-modules/file).
*/ */
id: string id: string
/** /**
* The name of the generated file as returned by the [File Module Provider](https://docs.medusajs.com/resources/architectural-modules/file). * The name of the generated file as returned by the [File Module Provider](https://docs.medusajs.com/resources/infrastructure-modules/file).
*/ */
filename: string filename: string
} }
@@ -80,7 +80,7 @@ export type GenerateProductCsvStepOutput = {
export const generateProductCsvStepId = "generate-product-csv" export const generateProductCsvStepId = "generate-product-csv"
/** /**
* This step generates a CSV file that exports products. The CSV * This step generates a CSV file that exports products. The CSV
* file is created and stored using the registered [File Module Provider](https://docs.medusajs.com/resources/architectural-modules/file). * file is created and stored using the registered [File Module Provider](https://docs.medusajs.com/resources/infrastructure-modules/file).
* *
* @example * @example
* const { data: products } = useQueryGraphStep({ * const { data: products } = useQueryGraphStep({
@@ -21,7 +21,7 @@ export const importProductsWorkflowId = "import-products"
* You can use this workflow within your custom workflows, allowing you to wrap custom logic around product import. * You can use this workflow within your custom workflows, allowing you to wrap custom logic around product import.
* For example, you can import products from another system. * For example, you can import products from another system.
* *
* The workflow only starts the import, but you'll have to confirm it using the [Workflow Engine](https://docs.medusajs.com/resources/architectural-modules/workflow-engine). * The workflow only starts the import, but you'll have to confirm it using the [Workflow Engine](https://docs.medusajs.com/resources/infrastructure-modules/workflow-engine).
* The below example shows how to confirm the import. * The below example shows how to confirm the import.
* *
* @example * @example
@@ -40,7 +40,7 @@ export const importProductsWorkflowId = "import-products"
* *
* Notice that the workflow returns a `transaction.transactionId`. You'll use this ID to confirm the import afterwards. * Notice that the workflow returns a `transaction.transactionId`. You'll use this ID to confirm the import afterwards.
* *
* You confirm the import using the [Workflow Engine](https://docs.medusajs.com/resources/architectural-modules/workflow-engine). * You confirm the import using the [Workflow Engine](https://docs.medusajs.com/resources/infrastructure-modules/workflow-engine).
* For example, in an API route: * For example, in an API route:
* *
* ```ts workflow={false} * ```ts workflow={false}
@@ -910,7 +910,7 @@ export type ConfigModule = {
* *
* :::note * :::note
* *
* Medusa's commerce modules are configured by default, so only * Medusa's Commerce Modules are configured by default, so only
* add them to this property if you're changing their configurations or adding providers to a module. * add them to this property if you're changing their configurations or adding providers to a module.
* *
* ::: * :::