docs: use tooling convention across docs (#10512)

2024-12-09 19:15:29 +02:00
1 parent 7c76ee24cb
commit 3409953c4f
@@ -10,7 +10,7 @@ The API Key Module provides API-key-related features in your Medusa and Node.js

 ## How to Use API Key Module's Service

-Use the API Key Module's main service by resolving from the Medusa container the resource `Modules.API_KEY` imported from `@medusajs/framework/utils`.
+Use the API Key Module's main service by resolving from the Medusa container the resource `Modules.API_KEY`.

 For example:

@@ -112,7 +112,7 @@ This workflow accepts the manager’s data and the associated auth identity’s
 The workflow has two steps:

 1. Create the manager using the `createManagerStep`.
-2. Set the `app_metadata` property of the associated auth identity using the `setAuthAppMetadataStep` step imported from `@medusajs/medusa/core-flows`. You specify the actor type `manager` in the `actorType` property of the step’s input.
+2. Set the `app_metadata` property of the associated auth identity using the `setAuthAppMetadataStep` from Medusa's core workflows. You specify the actor type `manager` in the `actorType` property of the step’s input.

 ---

@@ -10,7 +10,7 @@ The Auth Module provides authentication-related features in your Medusa and Node

 ## How to Use Auth Module's Service

-Use the Auth Module's main service by resolving from the Medusa container the resource `Modules.AUTH` imported from `@medusajs/framework/utils`.
+Use the Auth Module's main service by resolving from the Medusa container the resource `Modules.AUTH`.

 For example:

@@ -144,7 +144,7 @@ export default defineMiddlewares({
 })
 ```

-The `additional_data` parameter validation is customized using the `defineMiddlewares` utility function. In the routes middleware configuration object, the `additionalDataValidator` property accepts [Zod](https://zod.dev/) validaiton rules.
+The `additional_data` parameter validation is customized using `defineMiddlewares`. In the routes middleware configuration object, the `additionalDataValidator` property accepts [Zod](https://zod.dev/) validaiton rules.

 In the snippet above, you add a validation rule indicating that `custom_name` is a string that can be passed in the `additional_data` object.

@@ -260,9 +260,9 @@ The workflow accepts as an input the created cart and the `additional_data` para

 In the workflow, you:

-1. Use the `transform` utility to get the value of `custom_name` based on whether it's set in `additional_data`. Learn more about why you can't use conditional operators in a workflow without using `transform` in [this guide](!docs!/learn/fundamentals/workflows/conditions#why-if-conditions-arent-allowed-in-workflows).
+1. Use `transform` to get the value of `custom_name` based on whether it's set in `additional_data`. Learn more about why you can't use conditional operators in a workflow without using `transform` in [this guide](!docs!/learn/fundamentals/workflows/conditions#why-if-conditions-arent-allowed-in-workflows).
 2. Create the `Custom` record using the `createCustomStep`.
-3. Use the `when-then` utility to link the cart to the `Custom` record if it was created. Learn more about why you can't use if-then conditions in a workflow without using `when-then` in [this guide](!docs!/learn/fundamentals/workflows/conditions#why-if-conditions-arent-allowed-in-workflows).
+3. Use `when-then` to link the cart to the `Custom` record if it was created. Learn more about why you can't use if-then conditions in a workflow without using `when-then` in [this guide](!docs!/learn/fundamentals/workflows/conditions#why-if-conditions-arent-allowed-in-workflows).

 You'll next call the workflow in the hook handler.

@@ -556,7 +556,7 @@ const created = when({
 // TODO update, or delete Custom record
 ```

-Using the `when-then` utility, you check if the cart doesn't have a linked `Custom` record and the `custom_name` property is set. If so, you create a `Custom` record and link it to the cart.
+Using `when-then`, you check if the cart doesn't have a linked `Custom` record and the `custom_name` property is set. If so, you create a `Custom` record and link it to the cart.

 To create the `Custom` record, you use the `createCustomStep` you created in an earlier section.

@@ -589,7 +589,7 @@ const deleted = when({
 // TODO delete Custom record
 ```

-Using the `when-then` utility, you check if the cart has a linked `Custom` record and `custom_name` is `null` or an empty string. If so, you delete the linked `Custom` record and dismiss its links.
+Using `when-then`, you check if the cart has a linked `Custom` record and `custom_name` is `null` or an empty string. If so, you delete the linked `Custom` record and dismiss its links.

 Finally, replace the new `TODO` with the following:

@@ -614,7 +614,7 @@ return new WorkflowResponse({
 })
 ```

-Using the `when-then` utility, you check if the cart has a linked `Custom` record and `custom_name` is passed in the `additional_data`. If so, you update the linked `Custom` record.
+Using `when-then`, you check if the cart has a linked `Custom` record and `custom_name` is passed in the `additional_data`. If so, you update the linked `Custom` record.

 You return in the workflow response the created, updated, and deleted `Custom` record.

@@ -10,7 +10,7 @@ The Cart Module provides cart-related features in your Medusa and Node.js applic

 ## How to Use Cart Module's Service

-You can use the Cart Module's main service by resolving from the Medusa container the resource `Modules.CART` imported from `@medusajs/framework/utils`.
+You can use the Cart Module's main service by resolving from the Medusa container the resource `Modules.CART`.

 For example:

@@ -10,7 +10,7 @@ The Currency Module provides currency-related features in your Medusa and Node.j

 ## How to Use Currency Module's Service

-You can use the Currency Module's main service by resolving from the Medusa container the resource `Modules.CURRENCY` imported from `@medusajs/framework/utils`.
+You can use the Currency Module's main service by resolving from the Medusa container the resource `Modules.CURRENCY`.

 For example:

@@ -150,7 +150,7 @@ export default defineMiddlewares({
 })
 ```

-The `additional_data` parameter validation is customized using the `defineMiddlewares` utility function. In the routes middleware configuration object, the `additionalDataValidator` property accepts [Zod](https://zod.dev/) validaiton rules.
+The `additional_data` parameter validation is customized using `defineMiddlewares`. In the routes middleware configuration object, the `additionalDataValidator` property accepts [Zod](https://zod.dev/) validaiton rules.

 In the snippet above, you add a validation rule indicating that `custom_name` is a string that can be passed in the `additional_data` object.

@@ -266,9 +266,9 @@ The workflow accepts as an input the created customer and the `additional_data`

 In the workflow, you:

-1. Use the `transform` utility to get the value of `custom_name` based on whether it's set in `additional_data`. Learn more about why you can't use conditional operators in a workflow without using `transform` in [this guide](!docs!/learn/fundamentals/workflows/conditions#why-if-conditions-arent-allowed-in-workflows).
+1. Use `transform` to get the value of `custom_name` based on whether it's set in `additional_data`. Learn more about why you can't use conditional operators in a workflow without using `transform` in [this guide](!docs!/learn/fundamentals/workflows/conditions#why-if-conditions-arent-allowed-in-workflows).
 2. Create the `Custom` record using the `createCustomStep`.
-3. Use the `when-then` utility to link the customer to the `Custom` record if it was created. Learn more about why you can't use if-then conditions in a workflow without using `when-then` in [this guide](!docs!/learn/fundamentals/workflows/conditions#why-if-conditions-arent-allowed-in-workflows).
+3. Use `when-then` to link the customer to the `Custom` record if it was created. Learn more about why you can't use if-then conditions in a workflow without using `when-then` in [this guide](!docs!/learn/fundamentals/workflows/conditions#why-if-conditions-arent-allowed-in-workflows).

 You'll next execute the workflow in the hook handler.

@@ -568,7 +568,7 @@ const created = when({
 // TODO update, or delete Custom record
 ```

-Using the `when-then` utility, you check if the customer doesn't have a linked `Custom` record and the `custom_name` property is set. If so, you create a `Custom` record and link it to the customer.
+Using `when-then`, you check if the customer doesn't have a linked `Custom` record and the `custom_name` property is set. If so, you create a `Custom` record and link it to the customer.

 To create the `Custom` record, you use the `createCustomStep` you created in an earlier section.

@@ -601,7 +601,7 @@ const deleted = when({
 // TODO delete Custom record
 ```

-Using the `when-then` utility, you check if the customer has a linked `Custom` record and `custom_name` is `null` or an empty string. If so, you delete the linked `Custom` record and dismiss its links.
+Using `when-then`, you check if the customer has a linked `Custom` record and `custom_name` is `null` or an empty string. If so, you delete the linked `Custom` record and dismiss its links.

 Finally, replace the new `TODO` with the following:

@@ -626,7 +626,7 @@ return new WorkflowResponse({
 })
 ```

-Using the `when-then` utility, you check if the customer has a linked `Custom` record and `custom_name` is passed in the `additional_data`. If so, you update the linked `Custom` record.
+Using `when-then`, you check if the customer has a linked `Custom` record and `custom_name` is passed in the `additional_data`. If so, you update the linked `Custom` record.

 You return in the workflow response the created, updated, and deleted `Custom` record.

@@ -10,7 +10,7 @@ The Customer Module provides customer-related features in your Medusa and Node.j

 ## How to Use Customer Module's Service

-You can use the Customer Module's main service by resolving from the Medusa container the resource `Modules.CUSTOMER` imported from `@medusajs/framework/utils`.
+You can use the Customer Module's main service by resolving from the Medusa container the resource `Modules.CUSTOMER`.

 For example:

@@ -10,7 +10,7 @@ The Fulfillment Module provides fulfillment-related features in your Medusa and

 ## How to Use Fulfillment Module's Service

-You can use the Fulfillment Module's main service by resolving from the Medusa container the resource `Modules.FULFILLMENT` imported from `@medusajs/framework/utils`.
+You can use the Fulfillment Module's main service by resolving from the Medusa container the resource `Modules.FULFILLMENT`.

 For example:

@@ -10,7 +10,7 @@ The Inventory Module provides inventory-related features in your Medusa and Node

 ## How to Use Inventory Module's Service

-You can use the Inventory Module's main service by resolving from the Medusa container the resource `Modules.INVENTORY` imported from `@medusajs/framework/utils`.
+You can use the Inventory Module's main service by resolving from the Medusa container the resource `Modules.INVENTORY`.

 For example:

@@ -10,7 +10,7 @@ The Order Module provides order-related features in your Medusa and Node.js appl

 ## How to Use Order Module's Service

-You can use the Order Module's main service by resolving from the Medusa container the resource `Modules.ORDER` imported from `@medusajs/framework/utils`.
+You can use the Order Module's main service by resolving from the Medusa container the resource `Modules.ORDER`.

 For example:

@@ -11,7 +11,7 @@ The Payment Module provides payment-related features in your Medusa and Node.js

 ## How to Use Payment Module's Service

-You can use the Payment Module's main service by resolving from the Medusa container the resource `Modules.PAYMENT` imported from `@medusajs/framework/utils`.
+You can use the Payment Module's main service by resolving from the Medusa container the resource `Modules.PAYMENT`.

 For example:

@@ -10,7 +10,7 @@ The Pricing Module provides pricing-related features in your Medusa and Node.js

 ## How to Use Pricing Module's Service

-You can use the Pricing Module's main service by resolving from the Medusa container the resource `Modules.PRICING` imported from `@medusajs/framework/utils`.
+You can use the Pricing Module's main service by resolving from the Medusa container the resource `Modules.PRICING`.

 For example:

@@ -150,7 +150,7 @@ export default defineMiddlewares({
 })
 ```

-The `additional_data` parameter validation is customized using the `defineMiddlewares` utility function. In the routes middleware configuration object, the `additionalDataValidator` property accepts [Zod](https://zod.dev/) validaiton rules.
+The `additional_data` parameter validation is customized using `defineMiddlewares`. In the routes middleware configuration object, the `additionalDataValidator` property accepts [Zod](https://zod.dev/) validaiton rules.

 In the snippet above, you add a validation rule indicating that `custom_name` is a string that can be passed in the `additional_data` object.

@@ -266,9 +266,9 @@ The workflow accepts as an input the created product and the `additional_data` p

 In the workflow, you:

-1. Use the `transform` utility to get the value of `custom_name` based on whether it's set in `additional_data`. Learn more about why you can't use conditional operators in a workflow without using `transform` in [this guide](!docs!/learn/fundamentals/workflows/conditions#why-if-conditions-arent-allowed-in-workflows).
+1. Use `transform` to get the value of `custom_name` based on whether it's set in `additional_data`. Learn more about why you can't use conditional operators in a workflow without using `transform` in [this guide](!docs!/learn/fundamentals/workflows/conditions#why-if-conditions-arent-allowed-in-workflows).
 2. Create the `Custom` record using the `createCustomStep`.
-3. Use the `when-then` utility to link the product to the `Custom` record if it was created. Learn more about why you can't use if-then conditions in a workflow without using `when-then` in [this guide](!docs!/learn/fundamentals/workflows/conditions#why-if-conditions-arent-allowed-in-workflows).
+3. Use `when-then` to link the product to the `Custom` record if it was created. Learn more about why you can't use if-then conditions in a workflow without using `when-then` in [this guide](!docs!/learn/fundamentals/workflows/conditions#why-if-conditions-arent-allowed-in-workflows).

 You'll next execute the workflow in the hook handler.

@@ -574,7 +574,7 @@ const created = when({
 // TODO update, or delete Custom record
 ```

-Using the `when-then` utility, you check if the product doesn't have a linked `Custom` record and the `custom_name` property is set. If so, you create a `Custom` record and link it to the product.
+Using `when-then`, you check if the product doesn't have a linked `Custom` record and the `custom_name` property is set. If so, you create a `Custom` record and link it to the product.

 To create the `Custom` record, you use the `createCustomStep` you created in an earlier section.

@@ -607,7 +607,7 @@ const deleted = when({
 // TODO delete Custom record
 ```

-Using the `when-then` utility, you check if the product has a linked `Custom` record and `custom_name` is `null` or an empty string. If so, you delete the linked `Custom` record and dismiss its links.
+Using `when-then`, you check if the product has a linked `Custom` record and `custom_name` is `null` or an empty string. If so, you delete the linked `Custom` record and dismiss its links.

 Finally, replace the new `TODO` with the following:

@@ -632,7 +632,7 @@ return new WorkflowResponse({
 })
 ```

-Using the `when-then` utility, you check if the product has a linked `Custom` record and `custom_name` is passed in the `additional_data`. If so, you update the linked `Custom` record.
+Using `when-then`, you check if the product has a linked `Custom` record and `custom_name` is passed in the `additional_data`. If so, you update the linked `Custom` record.

 You return in the workflow response the created, updated, and deleted `Custom` record.

@@ -204,7 +204,7 @@ products.forEach((product) => {
 For each product variant, you:

 1. Retrieve its tax lines from the `taxLinesMap`.
-2. Calculate its prices with and without taxes using the `calculateAmountsWithTax` function imported from `@medusajs/framework/utils`.
+2. Calculate its prices with and without taxes using the `calculateAmountsWithTax` from the Medusa Framework.
 3. The `calculateAmountsWithTax` function returns an object having two properties:
    - `priceWithTax`: The variant's price with the taxes applied.
    - `priceWithoutTax`: The variant's price without taxes applied.
@@ -89,6 +89,6 @@ const { data: products } = await query.graph({

 For the context of the product variant's calculated price, you pass an object to `context` with the property `variants`, whose value is another object with the property `calculated_price`.

-`calculated_price`'s value is created using the `QueryContext` utility function, passing it a [calculation context object](../../../pricing/price-calculation/page.mdx#calculation-context).
+`calculated_price`'s value is created using `QueryContext` from the Modules SDK, passing it a [calculation context object](../../../pricing/price-calculation/page.mdx#calculation-context).

 Each variant in the retrieved products has a `calculated_price` object. Learn more about its properties in [this Pricing Module guide](../../../pricing/price-calculation/page.mdx#returned-price-object).
@@ -10,7 +10,7 @@ The Product Module provides product-related features in your Medusa and Node.js

 ## How to Use Product Module's Service

-You can use the Product Module's main service by resolving from the Medusa container the resource `Modules.PRODUCT` imported from `@medusajs/framework/utils`.
+You can use the Product Module's main service by resolving from the Medusa container the resource `Modules.PRODUCT`.

 For example:

@@ -150,7 +150,7 @@ export default defineMiddlewares({
 })
 ```

-The `additional_data` parameter validation is customized using the `defineMiddlewares` utility function. In the routes middleware configuration object, the `additionalDataValidator` property accepts [Zod](https://zod.dev/) validaiton rules.
+The `additional_data` parameter validation is customized using `defineMiddlewares`. In the routes middleware configuration object, the `additionalDataValidator` property accepts [Zod](https://zod.dev/) validaiton rules.

 In the snippet above, you add a validation rule indicating that `custom_name` is a string that can be passed in the `additional_data` object.

@@ -266,9 +266,9 @@ The workflow accepts as an input the created promotion and the `additional_data`

 In the workflow, you:

-1. Use the `transform` utility to get the value of `custom_name` based on whether it's set in `additional_data`. Learn more about why you can't use conditional operators in a workflow without using `transform` in [this guide](!docs!/learn/fundamentals/workflows/conditions#why-if-conditions-arent-allowed-in-workflows).
+1. Use `transform` to get the value of `custom_name` based on whether it's set in `additional_data`. Learn more about why you can't use conditional operators in a workflow without using `transform` in [this guide](!docs!/learn/fundamentals/workflows/conditions#why-if-conditions-arent-allowed-in-workflows).
 2. Create the `Custom` record using the `createCustomStep`.
-3. Use the `when-then` utility to link the promotion to the `Custom` record if it was created. Learn more about why you can't use if-then conditions in a workflow without using `when-then` in [this guide](!docs!/learn/fundamentals/workflows/conditions#why-if-conditions-arent-allowed-in-workflows).
+3. Use `when-then` to link the promotion to the `Custom` record if it was created. Learn more about why you can't use if-then conditions in a workflow without using `when-then` in [this guide](!docs!/learn/fundamentals/workflows/conditions#why-if-conditions-arent-allowed-in-workflows).

 You'll next execute the workflow in the hook handler.

@@ -580,7 +580,7 @@ const created = when({
 // TODO update, or delete Custom record
 ```

-Using the `when-then` utility, you check if the promotion doesn't have a linked `Custom` record and the `custom_name` property is set. If so, you create a `Custom` record and link it to the promotion.
+Using `when-then`, you check if the promotion doesn't have a linked `Custom` record and the `custom_name` property is set. If so, you create a `Custom` record and link it to the promotion.

 To create the `Custom` record, you use the `createCustomStep` you created in an earlier section.

@@ -613,7 +613,7 @@ const deleted = when({
 // TODO delete Custom record
 ```

-Using the `when-then` utility, you check if the promotion has a linked `Custom` record and `custom_name` is `null` or an empty string. If so, you delete the linked `Custom` record and dismiss its links.
+Using `when-then`, you check if the promotion has a linked `Custom` record and `custom_name` is `null` or an empty string. If so, you delete the linked `Custom` record and dismiss its links.

 Finally, replace the new `TODO` with the following:

@@ -638,7 +638,7 @@ return new WorkflowResponse({
 })
 ```

-Using the `when-then` utility, you check if the promotion has a linked `Custom` record and `custom_name` is passed in the `additional_data`. If so, you update the linked `Custom` record.
+Using `when-then`, you check if the promotion has a linked `Custom` record and `custom_name` is passed in the `additional_data`. If so, you update the linked `Custom` record.

 You return in the workflow response the created, updated, and deleted `Custom` record.

@@ -10,7 +10,7 @@ The Promotion Module provides promotion-related features in your Medusa and Node

 ## How to Use the Promotion Module's Service

-You can use the Promotion Module's main service by resolving from the Medusa container the resource `Modules.PROMOTION` imported from `@medusajs/framework/utils`.
+You can use the Promotion Module's main service by resolving from the Medusa container the resource `Modules.PROMOTION`.

 For example:

@@ -10,7 +10,7 @@ The Region Module provides region-related features in your Medusa and Node.js ap

 ## How to Use Region Module's Service

-You can use the Region Module's main service by resolving from the Medusa container the resource `Modules.REGION` imported from `@medusajs/framework/utils`.
+You can use the Region Module's main service by resolving from the Medusa container the resource `Modules.REGION`.

 For example:

@@ -10,7 +10,7 @@ The Sales Channel Module provides sales-channel-related features in your Medusa

 ## How to Use Sales Channel Module's Service

-You can use the Sales Channel Module's main service by resolving from the Medusa container the resource `Modules.SALES_CHANNEL` imported from `@medusajs/framework/utils`.
+You can use the Sales Channel Module's main service by resolving from the Medusa container the resource `Modules.SALES_CHANNEL`.

 For example:

@@ -10,7 +10,7 @@ The Stock Location Module provides stock-location-related features in your Medus

 ## How to Use Stock Location Module's Service

-You can use the Stock Location Module's main service by resolving from the Medusa container the resource `Modules.STOCK_LOCATION` imported from `@medusajs/framework/utils`.
+You can use the Stock Location Module's main service by resolving from the Medusa container the resource `Modules.STOCK_LOCATION`.

 For example:

@@ -10,7 +10,7 @@ The Store Module provides store-related features in your Medusa and Node.js appl

 ## How to Use Store Module's Service

-You can use the Store Module's main service by resolving from the Medusa container the resource `Modules.STORE` imported from `@medusajs/framework/utils`.
+You can use the Store Module's main service by resolving from the Medusa container the resource `Modules.STORE`.

 For example:

@@ -10,7 +10,7 @@ The Tax Module provides tax-related features in your Medusa and Node.js applicat

 ## How to Use Tax Module's Service

-You can use the Tax Module's main service by resolving from the Medusa container the resource `Modules.TAX` imported from `@medusajs/framework/utils`.
+You can use the Tax Module's main service by resolving from the Medusa container the resource `Modules.TAX`.

 For example:

@@ -10,7 +10,7 @@ The User Module provides user-related features in your Medusa and Node.js applic

 ## How to Use User Module's Service

-You can use the User Module's main service by resolving from the Medusa container the resource `Modules.USER` imported from `@medusajs/framework/utils`.
+You can use the User Module's main service by resolving from the Medusa container the resource `Modules.USER`.

 For example: