docs: changes for new releases + fixes (#12945)
* docs: changes for new releases + fixes * remove container option
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
3028425a86
commit
541bff8c9b
10 files changed
+175
-65
No files matched your search
@@ -70,6 +70,87 @@ module.exports = defineConfig({
|
||||
|
||||
The `projectConfig` object contains essential configurations related to the Medusa application, such as database and CORS configurations.
|
||||
|
||||
### cookieOptions
|
||||
|
||||
<Note>
|
||||
|
||||
This option is available since Medusa [v2.8.5](https://github.com/medusajs/medusa/releases/tag/v2.8.5).
|
||||
|
||||
</Note>
|
||||
|
||||
The `projectConfig.cookieOptions` configuration defines cookie options to be passed to `express-session` when creating the session cookie. This configuration is useful when simulating a production environment locally, where you may need to set options like `secure` or `sameSite`.
|
||||
|
||||
#### Example
|
||||
|
||||
```ts title="medusa-config.ts"
|
||||
module.exports = defineConfig({
|
||||
projectConfig: {
|
||||
cookieOptions: {
|
||||
sameSite: "lax",
|
||||
},
|
||||
// ...
|
||||
},
|
||||
// ...
|
||||
})
|
||||
```
|
||||
|
||||
#### Properties
|
||||
|
||||
Aside from the following options, you can pass any property that the [express-session's cookie option accepts](https://www.npmjs.com/package/express-session).
|
||||
|
||||
<TypeList
|
||||
types={[
|
||||
{
|
||||
name: "secure",
|
||||
type: "`boolean`",
|
||||
description: `Whether the cookie should only be sent over HTTPS. This is useful in production environments where you want to ensure that cookies are only sent over secure connections.`,
|
||||
defaultValue: `false in development, true in production`
|
||||
},
|
||||
{
|
||||
name: "sameSite",
|
||||
type: "`lax` | `strict` | `none`",
|
||||
description: `Controls the SameSite attribute of the cookie.`,
|
||||
defaultValue: `"none" in production. In development, this attribute is not set.`
|
||||
},
|
||||
{
|
||||
name: "maxAge",
|
||||
type: "`number`",
|
||||
description: "The maximum age of the cookie in milliseconds set in the `Set-Cookie` header.",
|
||||
defaultValue: "Either the `sessionOptions.ttl` option, or `10` hours."
|
||||
},
|
||||
{
|
||||
name: "httpOnly",
|
||||
type: "`boolean`",
|
||||
description: "Whether to set the `HttpOnly Set-Cookie` attribute.",
|
||||
defaultValue: `true`
|
||||
},
|
||||
{
|
||||
name: "priority",
|
||||
type: "`low` \| `medium` \| `high`",
|
||||
description: "The value of the [Priority Set-Cookie attribute](https://tools.ietf.org/html/draft-west-cookie-priority-00#section-4.1)",
|
||||
defaultValue: `medium`
|
||||
},
|
||||
{
|
||||
name: "domain",
|
||||
type: "`string`",
|
||||
description: "The value of the `Domain Set-Cookie` attribute. By default, no domain is set, and most clients will consider the cookie to apply to the current domain only."
|
||||
},
|
||||
{
|
||||
name: "path",
|
||||
type: "`string`",
|
||||
description: "The value of the `Path Set-Cookie` attribute",
|
||||
defaultValue: `/`
|
||||
},
|
||||
{
|
||||
name: "signed",
|
||||
type: "`boolean`",
|
||||
description: "Whether to sign the cookie.",
|
||||
defaultValue: `true`
|
||||
}
|
||||
]}
|
||||
openedLevel={1}
|
||||
/>
|
||||
|
||||
### databaseDriverOptions
|
||||
|
||||
The `projectConfig.databaseDriverOptions` configuration is an object of additional options used to configure the PostgreSQL connection. For example, you can support TLS/SSL connection using this configuration's `ssl` property.
|
||||
|
||||
@@ -45,7 +45,7 @@ The API routes that restrict the fields and relations you can retrieve are:
|
||||
|
||||
### How to Override Allowed Fields and Relations
|
||||
|
||||
For these routes, you need to override the allowed fields and relations to be retrieved. You can do this by adding a [middleware](../middlewares/page.mdx) to those routes.
|
||||
For these routes, you need to override the allowed fields and relations to be retrieved. You can do this by applying a [global middleware](../middlewares/page.mdx) to those routes.
|
||||
|
||||
For example, to allow retrieving the `b2b_company` of a customer using the [Get Customer Admin API Route](!api!/admin#customers_getcustomersid), create the file `src/api/middlewares.ts` with the following content:
|
||||
|
||||
@@ -66,10 +66,9 @@ export default defineMiddlewares({
|
||||
routes: [
|
||||
{
|
||||
matcher: "/store/customers/me",
|
||||
method: "GET",
|
||||
middlewares: [
|
||||
(req, res, next) => {
|
||||
req.allowed?.push("b2b_company")
|
||||
(req.allowed ??= []).push("b2b_company")
|
||||
next()
|
||||
},
|
||||
],
|
||||
@@ -90,3 +89,9 @@ curl 'http://localhost:9000/admin/customers/{id}?fields=*b2b_company' \
|
||||
```
|
||||
|
||||
In this example, you retrieve the `b2b_company` relation of the customer using the `fields` query parameter.
|
||||
|
||||
<Note title="Important">
|
||||
|
||||
This approach only works using a global middleware. It doesn't work in a route middleware.
|
||||
|
||||
</Note>
|
||||
@@ -151,9 +151,6 @@ export const setStepSuccessStep = createStep(
|
||||
workflowId: "hello-world",
|
||||
},
|
||||
stepResponse: new StepResponse("Done!"),
|
||||
options: {
|
||||
container,
|
||||
},
|
||||
})
|
||||
}
|
||||
)
|
||||
@@ -203,20 +200,6 @@ The `setStepSuccess` method of the workflow engine's main service accepts as a p
|
||||
description: "Set the response of the step. This is similar to the response you return in a step's definition, but since the `async` step doesn't have a response, you set its response when changing its status.",
|
||||
optional: false
|
||||
},
|
||||
{
|
||||
name: "options",
|
||||
type: "`Record<string, any>`",
|
||||
description: "Options to pass to the step.",
|
||||
optional: true,
|
||||
children: [
|
||||
{
|
||||
name: "container",
|
||||
type: "`MedusaContainer`",
|
||||
description: "An instance of the Medusa Container",
|
||||
optional: true
|
||||
}
|
||||
]
|
||||
}
|
||||
]}
|
||||
/>
|
||||
|
||||
@@ -269,9 +252,6 @@ export const setStepFailureStep = createStep(
|
||||
workflowId: "hello-world",
|
||||
},
|
||||
stepResponse: new StepResponse("Failed!"),
|
||||
options: {
|
||||
container,
|
||||
},
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
@@ -30,7 +30,7 @@ export const generatedEditDates = {
|
||||
"app/learn/fundamentals/workflows/conditions/page.mdx": "2025-01-27T08:45:19.027Z",
|
||||
"app/learn/fundamentals/modules/module-link-directions/page.mdx": "2024-07-24T09:16:01+02:00",
|
||||
"app/learn/fundamentals/admin/page.mdx": "2025-04-18T10:28:47.328Z",
|
||||
"app/learn/fundamentals/workflows/long-running-workflow/page.mdx": "2025-03-28T07:02:34.467Z",
|
||||
"app/learn/fundamentals/workflows/long-running-workflow/page.mdx": "2025-07-14T10:32:21.640Z",
|
||||
"app/learn/fundamentals/workflows/constructor-constraints/page.mdx": "2025-04-24T13:18:24.184Z",
|
||||
"app/learn/fundamentals/data-models/write-migration/page.mdx": "2025-03-24T06:41:48.915Z",
|
||||
"app/learn/fundamentals/data-models/manage-relationships/page.mdx": "2025-04-25T14:16:41.124Z",
|
||||
@@ -112,13 +112,13 @@ export const generatedEditDates = {
|
||||
"app/learn/resources/contribution-guidelines/admin-translations/page.mdx": "2025-02-11T16:57:46.726Z",
|
||||
"app/learn/resources/contribution-guidelines/docs/page.mdx": "2025-05-26T15:55:02.974Z",
|
||||
"app/learn/resources/usage/page.mdx": "2025-02-26T13:35:34.824Z",
|
||||
"app/learn/configurations/medusa-config/page.mdx": "2025-06-10T13:18:26.064Z",
|
||||
"app/learn/configurations/medusa-config/page.mdx": "2025-07-14T09:28:54.302Z",
|
||||
"app/learn/configurations/ts-aliases/page.mdx": "2025-02-11T16:57:46.683Z",
|
||||
"app/learn/production/worker-mode/page.mdx": "2025-03-11T15:21:50.906Z",
|
||||
"app/learn/fundamentals/module-links/read-only/page.mdx": "2025-05-13T15:04:12.107Z",
|
||||
"app/learn/fundamentals/data-models/properties/page.mdx": "2025-03-18T07:57:17.826Z",
|
||||
"app/learn/fundamentals/framework/page.mdx": "2025-06-26T14:26:22.120Z",
|
||||
"app/learn/fundamentals/api-routes/retrieve-custom-links/page.mdx": "2025-04-25T14:26:25.000Z",
|
||||
"app/learn/fundamentals/api-routes/retrieve-custom-links/page.mdx": "2025-07-14T10:24:32.582Z",
|
||||
"app/learn/fundamentals/workflows/errors/page.mdx": "2025-04-25T14:26:25.000Z",
|
||||
"app/learn/fundamentals/api-routes/override/page.mdx": "2025-05-09T08:01:24.493Z",
|
||||
"app/learn/fundamentals/module-links/index/page.mdx": "2025-05-23T07:57:58.958Z",
|
||||
|
||||
@@ -140,6 +140,39 @@ module.exports = defineConfig({
|
||||
|
||||
The `projectConfig` object contains essential configurations related to the Medusa application, such as database and CORS configurations.
|
||||
|
||||
### cookieOptions
|
||||
|
||||
This option is available since Medusa [v2.8.5](https://github.com/medusajs/medusa/releases/tag/v2.8.5).
|
||||
|
||||
The `projectConfig.cookieOptions` configuration defines cookie options to be passed to `express-session` when creating the session cookie. This configuration is useful when simulating a production environment locally, where you may need to set options like `secure` or `sameSite`.
|
||||
|
||||
#### Example
|
||||
|
||||
```ts title="medusa-config.ts"
|
||||
module.exports = defineConfig({
|
||||
projectConfig: {
|
||||
cookieOptions: {
|
||||
sameSite: "lax",
|
||||
},
|
||||
// ...
|
||||
},
|
||||
// ...
|
||||
})
|
||||
```
|
||||
|
||||
#### Properties
|
||||
|
||||
Aside from the following options, you can pass any property that the [express-session's cookie option accepts](https://www.npmjs.com/package/express-session).
|
||||
|
||||
- secure: (\`boolean\`)
|
||||
- sameSite: (\`lax\` | \`strict\` | \`none\`)
|
||||
- maxAge: (\`number\`) The maximum age of the cookie in milliseconds set in the \`Set-Cookie\` header.
|
||||
- httpOnly: (\`boolean\`) Whether to set the \`HttpOnly Set-Cookie\` attribute.
|
||||
- priority: (\`low\` | \`medium\` | \`high\`) The value of the \[Priority Set-Cookie attribute]\(https://tools.ietf.org/html/draft-west-cookie-priority-00#section-4.1)
|
||||
- domain: (\`string\`) The value of the \`Domain Set-Cookie\` attribute. By default, no domain is set, and most clients will consider the cookie to apply to the current domain only.
|
||||
- path: (\`string\`) The value of the \`Path Set-Cookie\` attribute
|
||||
- signed: (\`boolean\`) Whether to sign the cookie.
|
||||
|
||||
### databaseDriverOptions
|
||||
|
||||
The `projectConfig.databaseDriverOptions` configuration is an object of additional options used to configure the PostgreSQL connection. For example, you can support TLS/SSL connection using this configuration's `ssl` property.
|
||||
@@ -677,7 +710,7 @@ The value for this configuration can be one of the following:
|
||||
```ts title="medusa-config.ts"
|
||||
module.exports = defineConfig({
|
||||
projectConfig: {
|
||||
workerMode: process.env.WORKER_MODE || "shared",
|
||||
workerMode: process.env.WORKER_MODE as "shared" | "worker" | "server" || "shared",
|
||||
// ...
|
||||
},
|
||||
// ...
|
||||
@@ -7619,7 +7652,7 @@ The API routes that restrict the fields and relations you can retrieve are:
|
||||
|
||||
### How to Override Allowed Fields and Relations
|
||||
|
||||
For these routes, you need to override the allowed fields and relations to be retrieved. You can do this by adding a [middleware](https://docs.medusajs.com/learn/fundamentals/api-routes/middlewares/index.html.md) to those routes.
|
||||
For these routes, you need to override the allowed fields and relations to be retrieved. You can do this by applying a [global middleware](https://docs.medusajs.com/learn/fundamentals/api-routes/middlewares/index.html.md) to those routes.
|
||||
|
||||
For example, to allow retrieving the `b2b_company` of a customer using the [Get Customer Admin API Route](https://docs.medusajs.com/api/admin#customers_getcustomersid), create the file `src/api/middlewares.ts` with the following content:
|
||||
|
||||
@@ -7632,10 +7665,9 @@ export default defineMiddlewares({
|
||||
routes: [
|
||||
{
|
||||
matcher: "/store/customers/me",
|
||||
method: "GET",
|
||||
middlewares: [
|
||||
(req, res, next) => {
|
||||
req.allowed?.push("b2b_company")
|
||||
(req.allowed ??= []).push("b2b_company")
|
||||
next()
|
||||
},
|
||||
],
|
||||
@@ -7657,6 +7689,8 @@ curl 'http://localhost:9000/admin/customers/{id}?fields=*b2b_company' \
|
||||
|
||||
In this example, you retrieve the `b2b_company` relation of the customer using the `fields` query parameter.
|
||||
|
||||
This approach only works using a global middleware. It doesn't work in a route middleware.
|
||||
|
||||
|
||||
# Request Body and Query Parameter Validation
|
||||
|
||||
@@ -17308,9 +17342,6 @@ export const setStepSuccessStep = createStep(
|
||||
workflowId: "hello-world",
|
||||
},
|
||||
stepResponse: new StepResponse("Done!"),
|
||||
options: {
|
||||
container,
|
||||
},
|
||||
})
|
||||
}
|
||||
)
|
||||
@@ -17330,9 +17361,6 @@ The `setStepSuccess` method of the workflow engine's main service accepts as a p
|
||||
|
||||
- workflowId: (\`string\`) The ID of the workflow. This is the first parameter passed to \`createWorkflow\` when creating the workflow.
|
||||
- stepResponse: (\`StepResponse\`) Set the response of the step. This is similar to the response you return in a step's definition, but since the \`async\` step doesn't have a response, you set its response when changing its status.
|
||||
- options: (\`Record\<string, any>\`) Options to pass to the step.
|
||||
|
||||
- container: (\`MedusaContainer\`) An instance of the Medusa Container
|
||||
|
||||
### Change Step Status to Failed
|
||||
|
||||
@@ -17374,9 +17402,6 @@ export const setStepFailureStep = createStep(
|
||||
workflowId: "hello-world",
|
||||
},
|
||||
stepResponse: new StepResponse("Failed!"),
|
||||
options: {
|
||||
container,
|
||||
},
|
||||
})
|
||||
}
|
||||
)
|
||||
@@ -83992,6 +84017,7 @@ export const createRestockSubscriptionWorkflow = createWorkflow(
|
||||
return !customer.email
|
||||
}
|
||||
).then(() => {
|
||||
// @ts-ignore
|
||||
const { data } = useQueryGraphStep({
|
||||
entity: "customer",
|
||||
fields: ["email"],
|
||||
@@ -89892,14 +89918,14 @@ To implement the step, create the file `src/workflows/restaurant/steps/create-re
|
||||
```ts title="src/workflows/restaurant/steps/create-restaurant.ts" highlights={createRestaurantHighlight} collapsibleLines="1-7" expandMoreLabel="Show Imports"
|
||||
import { StepResponse, createStep } from "@medusajs/framework/workflows-sdk"
|
||||
import {
|
||||
CreateRestaurantDTO,
|
||||
CreateRestaurant,
|
||||
} from "../../../modules/restaurant/types/mutations"
|
||||
import { RESTAURANT_MODULE } from "../../../modules/restaurant"
|
||||
import RestaurantModuleService from "../../../modules/restaurant/service"
|
||||
|
||||
export const createRestaurantStep = createStep(
|
||||
"create-restaurant-step",
|
||||
async function (data: CreateRestaurantDTO, { container }) {
|
||||
async function (data: CreateRestaurant, { container }) {
|
||||
const restaurantModuleService: RestaurantModuleService = container.resolve(
|
||||
RESTAURANT_MODULE
|
||||
)
|
||||
@@ -89971,7 +89997,7 @@ Then, create the file `src/api/restaurants/route.ts` with the following content:
|
||||
import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http"
|
||||
import { MedusaError } from "@medusajs/framework/utils"
|
||||
import {
|
||||
CreateRestaurantDTO,
|
||||
CreateRestaurant,
|
||||
} from "../../modules/restaurant/types/mutations"
|
||||
import {
|
||||
createRestaurantWorkflow,
|
||||
@@ -89979,7 +90005,7 @@ import {
|
||||
import { restaurantSchema } from "./validation-schemas"
|
||||
|
||||
export async function POST(req: MedusaRequest, res: MedusaResponse) {
|
||||
const validatedBody = restaurantSchema.parse(req.body) as CreateRestaurantDTO
|
||||
const validatedBody = restaurantSchema.parse(req.body) as CreateRestaurant
|
||||
|
||||
if (!validatedBody) {
|
||||
return MedusaError.Types.INVALID_DATA
|
||||
@@ -91663,9 +91689,6 @@ export const setStepSuccessStep = createStep(
|
||||
workflowId: handleDeliveryWorkflowId,
|
||||
},
|
||||
stepResponse: new StepResponse(updatedDelivery, updatedDelivery.id),
|
||||
options: {
|
||||
container,
|
||||
},
|
||||
})
|
||||
}
|
||||
)
|
||||
@@ -91710,9 +91733,6 @@ export const setStepFailedStep = createStep(
|
||||
workflowId: handleDeliveryWorkflowId,
|
||||
},
|
||||
stepResponse: new StepResponse(updatedDelivery, updatedDelivery.id),
|
||||
options: {
|
||||
container,
|
||||
},
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
Reference in new issue
Block a user