diff --git a/www/apps/resources/app/architectural-modules/file/local/page.mdx b/www/apps/resources/app/architectural-modules/file/local/page.mdx index 71b979bfe6..957a1f67a4 100644 --- a/www/apps/resources/app/architectural-modules/file/local/page.mdx +++ b/www/apps/resources/app/architectural-modules/file/local/page.mdx @@ -1,12 +1,12 @@ import { Table } from "docs-ui" export const metadata = { - title: `Local File Provider Module`, + title: `Local File Module Provider`, } # {metadata.title} -The Local File Provider Module stores files uploaded to your Medusa application in the `/uploads` directory. +The Local File Module Provider stores files uploaded to your Medusa application in the `/uploads` directory. --- @@ -18,7 +18,7 @@ The Local File Module is installed by default in your application. -To install the Local File Provider Module, run the following command in the directory of your Medusa application: +To install the Local File Module Provider, run the following command in the directory of your Medusa application: ```bash npm2yarn npm install @medusajs/file-local-next diff --git a/www/apps/resources/app/architectural-modules/file/page.mdx b/www/apps/resources/app/architectural-modules/file/page.mdx index a34b8ba814..319c7c5765 100644 --- a/www/apps/resources/app/architectural-modules/file/page.mdx +++ b/www/apps/resources/app/architectural-modules/file/page.mdx @@ -1,7 +1,7 @@ import { ChildDocs } from "docs-ui" export const metadata = { - title: `File Provider Modules`, + title: `File Module Providers`, } # {metadata.title} @@ -10,9 +10,9 @@ A File Module exposes the functionalities to upload assets, such as product imag --- -## What is a File Provider Module? +## What is a File Module Provider? -A file provider module implements the logic of handling uploads and downloads. The File Module must have one file provider module configured. +A file module provider implements the logic of handling uploads and downloads. The File Module must have one file module provider configured. By default, Medusa uses the Local File Module. This module uploads files to the `uploads` directory of your Medusa application. @@ -22,6 +22,6 @@ This is useful for development. However, for production, it’s highly recommend --- -## Create a File Provider Module +## Create a File Module Provider -To create a file provider module, refer to [this guide](/references/file-provider-module). +To create a file module provider, refer to [this guide](/references/file-provider-module). diff --git a/www/apps/resources/app/architectural-modules/file/s3/page.mdx b/www/apps/resources/app/architectural-modules/file/s3/page.mdx index 1291c51732..37131b5d8c 100644 --- a/www/apps/resources/app/architectural-modules/file/s3/page.mdx +++ b/www/apps/resources/app/architectural-modules/file/s3/page.mdx @@ -1,12 +1,12 @@ import { Table, Tabs, TabsList, TabsContent, TabsContentWrapper, TabsTrigger } from "docs-ui" export const metadata = { - title: `S3 File Provider Module`, + title: `S3 File Module Provider`, } # {metadata.title} -The S3 File Provider Module integrates Amazon S3 and services following a compatible API (such as MinIO or DigitalOcean Spaces) to store files uploaded to your Medusa application. +The S3 File Module Provider integrates Amazon S3 and services following a compatible API (such as MinIO or DigitalOcean Spaces) to store files uploaded to your Medusa application. --- @@ -70,7 +70,7 @@ The S3 File Provider Module integrates Amazon S3 and services following a compat ## Install the S3 File Module -To install the S3 File Provider Module, run the following command in the directory of your Medusa application: +To install the S3 File Module Provider, run the following command in the directory of your Medusa application: ```bash npm2yarn npm install @medusajs/file-s3 diff --git a/www/apps/resources/app/architectural-modules/notification/local/page.mdx b/www/apps/resources/app/architectural-modules/notification/local/page.mdx index c67b904626..48e2b8a7b5 100644 --- a/www/apps/resources/app/architectural-modules/notification/local/page.mdx +++ b/www/apps/resources/app/architectural-modules/notification/local/page.mdx @@ -1,12 +1,12 @@ import { Table } from "docs-ui" export const metadata = { - title: `Local Notification Provider Module`, + title: `Local Notification Module Provider`, } # {metadata.title} -The Local Notification Provider Module simulates sending a notification, but only logs the notification's details in the terminal. This is useful for development. +The Local Notification Module Provider simulates sending a notification, but only logs the notification's details in the terminal. This is useful for development. --- @@ -14,11 +14,11 @@ The Local Notification Provider Module simulates sending a notification, but onl -The Local Notification Provider Module is installed by default in your application. +The Local Notification Module Provider is installed by default in your application. -To install the Local Notification Provider Module, run the following command in the directory of your Medusa application: +To install the Local Notification Module Provider, run the following command in the directory of your Medusa application: ```bash npm2yarn npm install @medusajs/notification-local diff --git a/www/apps/resources/app/architectural-modules/notification/page.mdx b/www/apps/resources/app/architectural-modules/notification/page.mdx index a8bcd17f97..ce9f1e0e57 100644 --- a/www/apps/resources/app/architectural-modules/notification/page.mdx +++ b/www/apps/resources/app/architectural-modules/notification/page.mdx @@ -1,7 +1,7 @@ import { ChildDocs } from "docs-ui" export const metadata = { - title: `Notification Provider Modules`, + title: `Notification Module Providers`, } # {metadata.title} @@ -12,19 +12,19 @@ You can resolve the Notification Module and send notifications in API routes, su --- -## What is a Notification Provider Module? +## What is a Notification Module Provider? -A notification provider module implements the logic of sending the notification. It either integrates a third-party service or uses custom logic to send the notification. +A notification module provider implements the logic of sending the notification. It either integrates a third-party service or uses custom logic to send the notification. By default, Medusa uses the Local Notification Module which only simulates sending the notification by logging a message in the terminal. -Medusa provides other Notification Modules that actually send notifications, such as the SendGrid Notification Provider Module. +Medusa provides other Notification Modules that actually send notifications, such as the SendGrid Notification Module Provider. --- -## Notification Provider Module Channels +## Notification Module Provider Channels When you send a notification, you specify the channel to send it through, such as `email` or `sms`. Each provider defined in the Notification Module's `providers` option has a `channels` option specifying which channels it can be used in. Only one provider can be setup for each channel. @@ -65,6 +65,6 @@ The `channels` option is an array of strings indicating the channels this provid --- -## Create a Notification Provider Module +## Create a Notification Module Provider -To create a notification provider module, refer to [this guide](/references/notification-provider-module). +To create a notification module provider, refer to [this guide](/references/notification-provider-module). diff --git a/www/apps/resources/app/architectural-modules/notification/send-notification/page.mdx b/www/apps/resources/app/architectural-modules/notification/send-notification/page.mdx index 996d8e62ea..3c6fa423b4 100644 --- a/www/apps/resources/app/architectural-modules/notification/send-notification/page.mdx +++ b/www/apps/resources/app/architectural-modules/notification/send-notification/page.mdx @@ -15,7 +15,7 @@ In your resource, such as a subscriber, resolve the Notification Module's main s export const highlights = [ ["12", "notificationModuleService", "Resolve the Notification Module."], ["17", "create", "Create the notification to be sent."], - ["19", '"email"', "Use the provider module defined for the `email` channel to send an email."], + ["19", '"email"', "Use the module provider defined for the `email` channel to send an email."], ["20", '"product-created"', "The ID of the template defined in the third-party service, such as SendGrid."], ["21", "data", "The data to pass to the template defined in the third-party service."] ] @@ -63,7 +63,7 @@ The `create` method accepts an object or an array of objects having the followin { name: "channel", type: "`string`", - description: "The channel to send the notification through. For example, `email` or `sms`. The provider module defined for that channel will be used to send the notification.", + description: "The channel to send the notification through. For example, `email` or `sms`. The module provider defined for that channel will be used to send the notification.", optional: false }, { diff --git a/www/apps/resources/app/architectural-modules/notification/sendgrid/page.mdx b/www/apps/resources/app/architectural-modules/notification/sendgrid/page.mdx index c3f5b3c00a..ae8a4c52b5 100644 --- a/www/apps/resources/app/architectural-modules/notification/sendgrid/page.mdx +++ b/www/apps/resources/app/architectural-modules/notification/sendgrid/page.mdx @@ -1,12 +1,12 @@ import { Table } from "docs-ui" export const metadata = { - title: `SendGrid Notification Provider Module`, + title: `SendGrid Notification Module Provider`, } # {metadata.title} -The SendGrid Notification Provider Module integrates [SendGrid](https://sendgrid.com) to send emails to users and customers. +The SendGrid Notification Module Provider integrates [SendGrid](https://sendgrid.com) to send emails to users and customers. --- @@ -20,7 +20,7 @@ The SendGrid Notification Provider Module integrates [SendGrid](https://sendgrid -To install the SendGrid Notification Provider Module, run the following command in the directory of your Medusa application: +To install the SendGrid Notification Module Provider, run the following command in the directory of your Medusa application: ```bash npm2yarn npm install @medusajs/notification-sendgrid @@ -180,7 +180,7 @@ In this subscriber: - Resolve the Notification Module's main service. - Use the `create` method of the main service to create a notification to be sent to the specified email. -- By specifying the `email` channel, the SendGrid Notification Provider Module is used to send the notification. +- By specifying the `email` channel, the SendGrid Notification Module Provider is used to send the notification. - The `template` property of the `create` method's parameter specifies the ID of the template defined in SendGrid. - The `data` property allows you to pass data to the template in SendGrid. diff --git a/www/apps/resources/app/commerce-modules/auth/auth-providers/_google/page.mdx b/www/apps/resources/app/commerce-modules/auth/auth-providers/_google/page.mdx index a1130a7873..93c6588d10 100644 --- a/www/apps/resources/app/commerce-modules/auth/auth-providers/_google/page.mdx +++ b/www/apps/resources/app/commerce-modules/auth/auth-providers/_google/page.mdx @@ -1,22 +1,22 @@ import { Table } from "docs-ui" export const metadata = { - title: `Google Auth Provider Module`, + title: `Google Auth Module Provider`, } # {metadata.title} -In this document, you’ll learn about the Google auth provider module and how to install and use it in the Auth Module. +In this document, you’ll learn about the Google auth module provider and how to install and use it in the Auth Module. ## Features -The Google auth provider module handles authenticating users with their Google accounts. +The Google auth module provider handles authenticating users with their Google accounts. By integrating the Google auth provider, you provide your users and customers with the ability to login with their Google account. --- -## Install the Google Auth Provider Module +## Install the Google Auth Module Provider @@ -28,7 +28,7 @@ By integrating the Google auth provider, you provide your users and customers wi -To install the Google auth provider module, run the following command in the directory of your Medusa application: +To install the Google auth module provider, run the following command in the directory of your Medusa application: ```bash npm2yarn npm install @medusajs/auth-google diff --git a/www/apps/resources/app/commerce-modules/auth/auth-providers/emailpass/page.mdx b/www/apps/resources/app/commerce-modules/auth/auth-providers/emailpass/page.mdx index 3da27b7502..ca33191000 100644 --- a/www/apps/resources/app/commerce-modules/auth/auth-providers/emailpass/page.mdx +++ b/www/apps/resources/app/commerce-modules/auth/auth-providers/emailpass/page.mdx @@ -1,20 +1,20 @@ import { Table } from "docs-ui" export const metadata = { - title: `Emailpass Auth Provider Module`, + title: `Emailpass Auth Module Provider`, } # {metadata.title} -In this document, you’ll learn about the Emailpass auth provider module and how to install and use it in the Auth Module. +In this document, you’ll learn about the Emailpass auth module provider and how to install and use it in the Auth Module. ## Features -Using the Emailpass auth provider module, you allow users to register and login with an email and password. +Using the Emailpass auth module provider, you allow users to register and login with an email and password. --- -## Install the Emailpass Auth Provider Module +## Install the Emailpass Auth Module Provider The Emailpass auth provider is registered by default with the Auth Module. diff --git a/www/apps/resources/app/commerce-modules/auth/auth-providers/page.mdx b/www/apps/resources/app/commerce-modules/auth/auth-providers/page.mdx index d23d40f6b8..7e144c4350 100644 --- a/www/apps/resources/app/commerce-modules/auth/auth-providers/page.mdx +++ b/www/apps/resources/app/commerce-modules/auth/auth-providers/page.mdx @@ -6,15 +6,15 @@ export const metadata = { In this document, you’ll learn how the Auth Module handles authentication using providers. -## What's an Auth Provider Module? +## What's an Auth Module Provider? -An auth provider module handles authenticating customers and users, either using custom logic or by integrating a third-party service. +An auth module provider handles authenticating customers and users, either using custom logic or by integrating a third-party service. -For example, the EmailPass Auth Provider Module authenticates a user using their email and password, whereas the Google Auth Provider Module authenticates users using their Google account. +For example, the EmailPass Auth Module Provider authenticates a user using their email and password, whereas the Google Auth Module Provider authenticates users using their Google account. -Support for the Google Auth Provider Module is coming soon. +Support for the Google Auth Module Provider is coming soon. @@ -22,7 +22,7 @@ Support for the Google Auth Provider Module is coming soon. ## Configure Allowed Auth Providers of Actor Types -By default, users of all actor types can authenticate with all installed auth provider moduless. +By default, users of all actor types can authenticate with all installed auth module providerss. To restrict the auth providers used for actor types, use the [authMethodsPerActor option](/references/medusa-config#http-authMethodsPerActor-1-3) in Medusa's configurations: @@ -49,6 +49,6 @@ When you specify the `authMethodsPerActor` configuration, it overrides the defau --- -## How to Create an Auth Provider Module +## How to Create an Auth Module Provider -Refer to [this guide](/references/auth/provider) to learn how to create an auth provider module. +Refer to [this guide](/references/auth/provider) to learn how to create an auth module provider. diff --git a/www/apps/resources/app/commerce-modules/auth/module-options/page.mdx b/www/apps/resources/app/commerce-modules/auth/module-options/page.mdx index 7f6978101e..dfaa96ff46 100644 --- a/www/apps/resources/app/commerce-modules/auth/module-options/page.mdx +++ b/www/apps/resources/app/commerce-modules/auth/module-options/page.mdx @@ -14,7 +14,7 @@ In this document, you'll learn about the options of the Auth Module. ## providers -The `providers` option is an array of auth provider modules. +The `providers` option is an array of auth module providers. When the Medusa application starts, these providers are registered and can be used to handle authentication. @@ -49,9 +49,9 @@ module.exports = defineConfig({ The `providers` option is an array of objects that accept the following properties: -- `resolve`: A string indicating the package name of the auth provider module or the path to it. -- `options`: An optional object of the auth provider module's options. The object must have the following property: - - `config`: An object whose key is the ID of the auth provider, and its value is an object of options to pass to the provider module. +- `resolve`: A string indicating the package name of the module provider or the path to it. +- `options`: An optional object of the module provider's options. The object must have the following property: + - `config`: An object whose key is the ID of the auth provider, and its value is an object of options to pass to the module provider. --- diff --git a/www/apps/resources/app/commerce-modules/fulfillment/fulfillment-provider/page.mdx b/www/apps/resources/app/commerce-modules/fulfillment/fulfillment-provider/page.mdx index 53c1c2f3f5..19cadad623 100644 --- a/www/apps/resources/app/commerce-modules/fulfillment/fulfillment-provider/page.mdx +++ b/www/apps/resources/app/commerce-modules/fulfillment/fulfillment-provider/page.mdx @@ -1,16 +1,16 @@ export const metadata = { - title: `Fulfillment Provider Module`, + title: `Fulfillment Module Provider`, } # {metadata.title} -In this document, you’ll learn what a fulfillment provider module is. +In this document, you’ll learn what a fulfillment module provider is. -## What’s a Fulfillment Provider Module? +## What’s a Fulfillment Module Provider? -A fulfillment provider module handles fulfilling items, typically using a third-party integration. +A fulfillment module provider handles fulfilling items, typically using a third-party integration. -Fulfillment provider modules are stored and represented by the [FulfillmentProvider data model](/references/fulfillment/models/FulfillmentProvider). +Fulfillment module providers are stored and represented by the [FulfillmentProvider data model](/references/fulfillment/models/FulfillmentProvider). --- @@ -24,4 +24,4 @@ Learn more about the `providers` option in [this documentation](../module-option ## How to Create a Fulfillment Provider? -Refer to [this guide](/references/fulfillment/provider) to learn how to create a fulfillment provider module. +Refer to [this guide](/references/fulfillment/provider) to learn how to create a fulfillment module provider. diff --git a/www/apps/resources/app/commerce-modules/fulfillment/module-options/page.mdx b/www/apps/resources/app/commerce-modules/fulfillment/module-options/page.mdx index a3ff007bba..86bcd43f55 100644 --- a/www/apps/resources/app/commerce-modules/fulfillment/module-options/page.mdx +++ b/www/apps/resources/app/commerce-modules/fulfillment/module-options/page.mdx @@ -14,7 +14,7 @@ In this document, you'll learn about the options of the Fulfillment Module. ## providers -The `providers` option is an array of fulfillment provider modules. +The `providers` option is an array of fulfillment module providers. When the Medusa application starts, these providers are registered and can be used to process fulfillments. @@ -51,6 +51,6 @@ module.exports = defineConfig({ The `providers` option is an array of objects that accept the following properties: -- `resolve`: A string indicating either the package name of the fulfillment provider module or the path to it relative to the `src` directory. -- `options`: An optional object of the fulfillment provider module's options. The object must have the following property: - - `config`: An object whose key is the ID of the fulfillment provider, and its value is an object of options to pass to the provider module. \ No newline at end of file +- `resolve`: A string indicating either the package name of the module provider or the path to it relative to the `src` directory. +- `options`: An optional object of the module provider's options. The object must have the following property: + - `config`: An object whose key is the ID of the module provider, and its value is an object of options to pass to the module provider. \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/payment/module-options/page.mdx b/www/apps/resources/app/commerce-modules/payment/module-options/page.mdx index 127474bc4a..f67f18b69f 100644 --- a/www/apps/resources/app/commerce-modules/payment/module-options/page.mdx +++ b/www/apps/resources/app/commerce-modules/payment/module-options/page.mdx @@ -97,7 +97,7 @@ In this document, you'll learn about the options of the Payment Module. ## providers -The `providers` option is an array of payment provider modules. +The `providers` option is an array of payment module providers. When the Medusa application starts, these providers are registered and can be used to process payments. @@ -130,6 +130,6 @@ module.exports = defineConfig({ The `providers` option is an array of objects that accept the following properties: -- `resolve`: A string indicating the package name of the payment provider module or the path to it relative to the `src` directory. -- `options`: An optional object of the payment provider module's options. The object must have the following property: - - `config`: An object whose key is the ID of the payment provider, and its value is an object of options to pass to the provider module. \ No newline at end of file +- `resolve`: A string indicating the package name of the module provider or the path to it relative to the `src` directory. +- `options`: An optional object of the module provider's options. The object must have the following property: + - `config`: An object whose key is the ID of the module provider, and its value is an object of options to pass to the module provider. \ No newline at end of file diff --git a/www/apps/resources/app/commerce-modules/payment/payment-provider/page.mdx b/www/apps/resources/app/commerce-modules/payment/payment-provider/page.mdx index a3bfb87bea..41879f08db 100644 --- a/www/apps/resources/app/commerce-modules/payment/payment-provider/page.mdx +++ b/www/apps/resources/app/commerce-modules/payment/payment-provider/page.mdx @@ -1,22 +1,22 @@ import { ChildDocs } from "docs-ui" export const metadata = { - title: `Payment Provider Module`, + title: `Payment Module Provider`, } # {metadata.title} -In this document, you’ll learn what a payment provider module is. +In this document, you’ll learn what a payment module provider is. -## What's a Payment Provider Module? +## What's a Payment Module Provider? -A payment provider module registers a payment provider that handles payment processing. It can integrate third-party payment providers, such as Stripe. +A payment module provider registers a payment provider that handles payment processing. It can integrate third-party payment providers, such as Stripe. To authorize a payment amount with a payment provider, a payment session is created and associated with that payment provider. The payment provider is then used to handle the authorization. After the payment session is authorized, the payment provider is associated with the resulting payment and handles its payment processing, such as to capture or refund payment. -### List of Payment Provider Modules +### List of Payment Module Providers diff --git a/www/apps/resources/app/commerce-modules/payment/payment-provider/stripe/page.mdx b/www/apps/resources/app/commerce-modules/payment/payment-provider/stripe/page.mdx index 1b47cd9a58..035f737563 100644 --- a/www/apps/resources/app/commerce-modules/payment/payment-provider/stripe/page.mdx +++ b/www/apps/resources/app/commerce-modules/payment/payment-provider/stripe/page.mdx @@ -5,12 +5,12 @@ sidebar_label: "Stripe" import { Table } from "docs-ui" export const metadata = { - title: `Stripe Provider Module`, + title: `Stripe Module Provider`, } # {metadata.title} -In this document, you’ll learn about the Stripe provider module and how to install and use it in the Payment Module. +In this document, you’ll learn about the Stripe Module Provider and how to install and use it in the Payment Module. ## Features @@ -20,7 +20,7 @@ These features are also available in a safe test environment, allowing for a con --- -## Install the Stripe Provider Module +## Install the Stripe Module Provider @@ -30,7 +30,7 @@ These features are also available in a safe test environment, allowing for a con -To install the Stripe provider module, run the following command in the directory of your Medusa application: +To install the Stripe Module Provider, run the following command in the directory of your Medusa application: ```bash npm2yarn npm install @medusajs/payment-stripe diff --git a/www/apps/resources/app/commerce-modules/tax/module-options/page.mdx b/www/apps/resources/app/commerce-modules/tax/module-options/page.mdx index 26062afda5..5b5ba89612 100644 --- a/www/apps/resources/app/commerce-modules/tax/module-options/page.mdx +++ b/www/apps/resources/app/commerce-modules/tax/module-options/page.mdx @@ -14,7 +14,7 @@ In this document, you'll learn about the options of the Tax Module. ## providers -The `providers` option is an array of either tax provider modules, tax plugins, or path to a file that defines a tax provider. +The `providers` option is an array of either tax module providers, tax plugins, or path to a file that defines a tax provider. When the Medusa application starts, these providers are registered and can be used to retrieve tax lines. @@ -45,5 +45,5 @@ module.exports = defineConfig({ The objects in the array accept the following properties: -- `resolve`: A string indicating the package name of the tax provider module or the path to it relative to the `src` directory. -- `options`: An object of options to pass to the tax provider. +- `resolve`: A string indicating the package name of the module provider or the path to it relative to the `src` directory. +- `options`: An object of options to pass to the module provider. diff --git a/www/apps/resources/app/commerce-modules/tax/tax-calculation-with-provider/page.mdx b/www/apps/resources/app/commerce-modules/tax/tax-calculation-with-provider/page.mdx index 5412ca36ca..12b1857014 100644 --- a/www/apps/resources/app/commerce-modules/tax/tax-calculation-with-provider/page.mdx +++ b/www/apps/resources/app/commerce-modules/tax/tax-calculation-with-provider/page.mdx @@ -45,13 +45,13 @@ The example above returns the tax lines based on the tax region for the United S The tax lines retrieved by the `getTaxLines` method are actually retrieved from the tax region’s provider. -A tax provider module whose main service implements the logic to shape tax lines. Each tax region has a tax provider. +A tax module provider whose main service implements the logic to shape tax lines. Each tax region has a tax provider. The Tax Module provides a `system` tax provider that only transforms calculated item and shipping tax rates into the required return type. {/* --- -TODO add once tax provider guide is updated + add provider modules match other modules. +TODO add once tax provider guide is updated + add module providers match other modules. ## Create Tax Provider diff --git a/www/apps/resources/app/nextjs-starter/page.mdx b/www/apps/resources/app/nextjs-starter/page.mdx index 31af978884..53b33d34f3 100644 --- a/www/apps/resources/app/nextjs-starter/page.mdx +++ b/www/apps/resources/app/nextjs-starter/page.mdx @@ -97,7 +97,7 @@ The Next.js Starter storefront is compatible with Medusa's Stripe and PayPal plu -- [Stripe provider module](../commerce-modules/payment/payment-provider/stripe/page.mdx) installed in the Medusa application. +- [Stripe module provider](../commerce-modules/payment/payment-provider/stripe/page.mdx) installed in the Medusa application. diff --git a/www/apps/resources/app/recipes/commerce-automation/page.mdx b/www/apps/resources/app/recipes/commerce-automation/page.mdx index 9bdb46c1f6..a6aa608f1e 100644 --- a/www/apps/resources/app/recipes/commerce-automation/page.mdx +++ b/www/apps/resources/app/recipes/commerce-automation/page.mdx @@ -411,7 +411,7 @@ The [Events reference](../../events-reference/page.mdx) shows an extensive list */} -Medusa also provides Notification Provider Modules that integrate with third-party services, such as SendGrid. +Medusa also provides Notification Module Providers that integrate with third-party services, such as SendGrid. diff --git a/www/apps/resources/app/recipes/digital-products/page.mdx b/www/apps/resources/app/recipes/digital-products/page.mdx index 9226d5149b..9b9061b8bd 100644 --- a/www/apps/resources/app/recipes/digital-products/page.mdx +++ b/www/apps/resources/app/recipes/digital-products/page.mdx @@ -25,26 +25,26 @@ You can create a Digital Product Module that introduces the concept of a digital --- -## Install a File Provider Module +## Install a File Module Provider -A file provider module handles storage functionalities in Medusa. This includes uploading, retrieving, and downloading files, among other features. +A file module provider handles storage functionalities in Medusa. This includes uploading, retrieving, and downloading files, among other features. -Use a file provider module to manage your stored digital products. +Use a file module provider to manage your stored digital products. -During development, you can use the Local File Provider Module, which is installed by default in your store. For production, check out available file provider modules or create your own. +During development, you can use the Local File Module Provider, which is installed by default in your store. For production, check out available file module providers or create your own. , showLinkIcon: false }, { href: "/references/file-provider-module", - title: "Create a File Provider Module", - text: "Learn how to create a file provider module.", + title: "Create a File Module Provider", + text: "Learn how to create a file module provider.", startIcon: , showLinkIcon: false }, @@ -52,27 +52,27 @@ During development, you can use the Local File Provider Module, which is install --- -## Install a Notification Provider Module +## Install a Notification Module Provider -A notification provider module handles sending notifications to users and customers. +A notification module provider handles sending notifications to users and customers. -For digital products, a notification provider module allows you to send the customer an email or another form of notification with a link to download the file they purchased. +For digital products, a notification module provider allows you to send the customer an email or another form of notification with a link to download the file they purchased. -You can use one of Medusa’s notification provider modules or create your own. +You can use one of Medusa’s notification module providers or create your own. {/* TODO add links */} , showLinkIcon: false }, { href: "/references/notification-provider-module", - title: "Create a Notification Provider Module", + title: "Create a Notification Module Provider", text: "Learn how to create a custom notification service.", startIcon: , showLinkIcon: false, @@ -1057,7 +1057,7 @@ In your customizations, you send requests to the API routes you created to creat When a customer purchases a digital product, they should receive a link to download it. -You can create a subscriber that listens to the `order.placed` event. In the subscriber, you check for the digital products in the order and obtain the download URLs using the file provider module’s `getPresignedDownloadUrl` method. +You can create a subscriber that listens to the `order.placed` event. In the subscriber, you check for the digital products in the order and obtain the download URLs using the file module provider’s `getPresignedDownloadUrl` method. @@ -1067,11 +1067,11 @@ The `order.placed` event isn't currently emitted. -Following this approach assumes the file provider module you're using handles creating secure pre-signed URLs with an expiration mechanism. Alternatively, create a token on purchase using the API Key Module and create an API route that validates that token. +Following this approach assumes the file module provider you're using handles creating secure pre-signed URLs with an expiration mechanism. Alternatively, create a token on purchase using the API Key Module and create an API route that validates that token. -In the subscriber, you can send a notification, such as an email, to the customer using the notification provider module of your choice. That notification would hold the download links to the products the customer purchased. +In the subscriber, you can send a notification, such as an email, to the customer using the notification module provider of your choice. That notification would hold the download links to the products the customer purchased. - Here’s an example of a subscriber that retrieves the download links and sends them to the customer using the installed notification provider module: + Here’s an example of a subscriber that retrieves the download links and sends them to the customer using the installed notification module provider: ```ts title="src/subscribers/handle-order.ts" badgeLabel="Medusa Application" collapsibleLines="1-15" expandButtonLabel="Show Imports" import { @@ -1168,7 +1168,7 @@ In the subscriber, you can send a notification, such as an email, to the custome } ``` - The `handleOrderPlaced` subscriber function retrieves the order, loops over its items to find digital products and retrieve their download links, then uses the installed notification provider module to send the email, passing the URLs as a data payload. You can customize the sent data based on your template and your use case. + The `handleOrderPlaced` subscriber function retrieves the order, loops over its items to find digital products and retrieve their download links, then uses the installed notification module provider to send the email, passing the URLs as a data payload. You can customize the sent data based on your template and your use case. */} diff --git a/www/apps/resources/app/recipes/multi-region-store/page.mdx b/www/apps/resources/app/recipes/multi-region-store/page.mdx index 847ed9697b..77eba6fe4e 100644 --- a/www/apps/resources/app/recipes/multi-region-store/page.mdx +++ b/www/apps/resources/app/recipes/multi-region-store/page.mdx @@ -70,7 +70,7 @@ Merchants choose which payment and fulfillment providers are available in each r During checkout, customers only see the payment providers and shipping options configured for the region. This lets you give customers a localized experience that feels familiar and instills trust. -Medusa provides official provider modules for payment and fulfillment. You can also create custom provider modules. +Medusa provides official module providers for payment and fulfillment. You can also create custom module providers. , showLinkIcon: false }, diff --git a/www/apps/resources/app/recipes/oms/page.mdx b/www/apps/resources/app/recipes/oms/page.mdx index 723698fa7f..a02bdb1068 100644 --- a/www/apps/resources/app/recipes/oms/page.mdx +++ b/www/apps/resources/app/recipes/oms/page.mdx @@ -63,9 +63,9 @@ For example, you can support importing orders into Medusa through a custom API R ## Route Orders to Third-party Fulfillment Services -To integrate third-party fulfillment providers with the Medusa application, create a fulfillment provider module. +To integrate third-party fulfillment providers with the Medusa application, create a fulfillment module provider. -Medusa uses the Fulfillment Module whenever a fulfillment action is performed, such as when a fulfillment is created for items in an order. The module's main service's methods use the associated fulfillment provider module to handle the desired fulfillment actions. +Medusa uses the Fulfillment Module whenever a fulfillment action is performed, such as when a fulfillment is created for items in an order. The module's main service's methods use the associated fulfillment module provider to handle the desired fulfillment actions. ![Fulfilling orders with Medusa OMS](https://res.cloudinary.com/dza7lstvk/image/upload/v1709032184/Medusa%20Book/oms-fulfillment_qfrpdd.jpg) @@ -80,7 +80,7 @@ Emitting of event `order.fulfillment_created` isn't implemented yet. , showLinkIcon: false @@ -98,7 +98,7 @@ Emitting of event `order.fulfillment_created` isn't implemented yet. ## Process Payment with Third-Party Providers -To integrate third-party payment providers with the Medusa application, create a payment provider module. +To integrate third-party payment providers with the Medusa application, create a payment module provider. In addition, create a subscriber that listen to payment-related events, such as the `order.payment_captured` event, to perform actions in the third-party payment provider. @@ -111,8 +111,8 @@ Emitting of event `order.payment_captured` isn't implemented yet. , showLinkIcon: false }, @@ -171,7 +171,7 @@ All types of order changes are coming soon. In Medusa, items in an order can be returned or exchanged; these can be created by the merchant or requested by the customer. A merchant can also edit an order to add, update, or delete items. -When changes are made to an order by any of the mentioned actions, the changes are reflected on the order's totals and associated inventory. The integrated fulfillment and payment provider modules are used if fulfillment or payment actions are required, such as fulfilling exchanged items. +When changes are made to an order by any of the mentioned actions, the changes are reflected on the order's totals and associated inventory. The integrated fulfillment and payment module providers are used if fulfillment or payment actions are required, such as fulfilling exchanged items. Medusa also emits events related to these actions, such as `order.return_requested`. So, you can create a subscriber that listens to these events and perform asynchronous actions, such as communicating with third-party services. diff --git a/www/apps/resources/app/recipes/personalized-products/page.mdx b/www/apps/resources/app/recipes/personalized-products/page.mdx index c96311c4e9..16d45751a4 100644 --- a/www/apps/resources/app/recipes/personalized-products/page.mdx +++ b/www/apps/resources/app/recipes/personalized-products/page.mdx @@ -126,9 +126,9 @@ The `order.placed` event is currently not emitted. ## Fulfill Personalized Products in Orders -To fulfill your personalized products with a third-party service or custom logic, create a fulfillment provider module. +To fulfill your personalized products with a third-party service or custom logic, create a fulfillment module provider. -The Fulfillment Module registers your fulfillment provider module to use it to fulfill orders. +The Fulfillment Module registers your fulfillment module provider to use it to fulfill orders. , showLinkIcon: false }, diff --git a/www/apps/resources/app/recipes/subscriptions/page.mdx b/www/apps/resources/app/recipes/subscriptions/page.mdx index 7449a9ecc2..be134d778f 100644 --- a/www/apps/resources/app/recipes/subscriptions/page.mdx +++ b/www/apps/resources/app/recipes/subscriptions/page.mdx @@ -58,12 +58,12 @@ Stripe provides a [subscription payments feature](https://stripe.com/docs/billin This approach allows you to delegate the complications of implementing the subscription logic to Stripe, but doesn't support using other payment providers. -Although Medusa provides a Stripe provider module, it doesn't handle subscriptions. You can create a custom Stripe Subscription payment module. +Although Medusa provides a Stripe module provider, it doesn't handle subscriptions. You can create a custom Stripe Subscription payment module. } showLinkIcon={false} /> diff --git a/www/apps/resources/app/storefront-development/checkout/payment/stripe/page.mdx b/www/apps/resources/app/storefront-development/checkout/payment/stripe/page.mdx index d10812bdd5..5dcb14e000 100644 --- a/www/apps/resources/app/storefront-development/checkout/payment/stripe/page.mdx +++ b/www/apps/resources/app/storefront-development/checkout/payment/stripe/page.mdx @@ -16,7 +16,7 @@ For other types of storefronts, the steps are similar. However, refer to [Stripe -- [Stripe Provider Module](../../../../commerce-modules/payment/payment-provider/stripe/page.mdx) installed and configured in your Medusa application. +- [Stripe Module Provider](../../../../commerce-modules/payment/payment-provider/stripe/page.mdx) installed and configured in your Medusa application. - [Stripe publishable API key](https://support.stripe.com/questions/locate-api-keys-in-the-dashboard). diff --git a/www/vale/styles/docs/ModuleNames.yml b/www/vale/styles/docs/ModuleNames.yml index d3683a9325..609fef20bd 100644 --- a/www/vale/styles/docs/ModuleNames.yml +++ b/www/vale/styles/docs/ModuleNames.yml @@ -16,4 +16,4 @@ exceptions: - the link module - the first module - the second module - - the provider module \ No newline at end of file + - the module provider \ No newline at end of file