docs: rename provider module to module provider (#7869)

* docs: rename provider module to module provider * fix vale rule * vale fixes
2024-07-01 10:21:19 +03:00
parent 2833e3c4d0
commit 1842cd33cf
28 changed files with 117 additions and 117 deletions
@@ -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

 <Note type="check">

@@ -28,7 +28,7 @@ By integrating the Google auth provider, you provide your users and customers wi

 </Note>

-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
@@ -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.

@@ -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.

 <Note type="soon">

-Support for the Google Auth Provider Module is coming soon.
+Support for the Google Auth Module Provider is coming soon.

 </Note>

@@ -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.
@@ -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.

 ---

@@ -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.
@@ -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.
+- `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.
@@ -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.
+- `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.
@@ -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

 <ChildDocs type="item" />

@@ -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

 <Note type="check">

@@ -30,7 +30,7 @@ These features are also available in a safe test environment, allowing for a con

 </Note>

-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
@@ -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.
@@ -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