docs: fix imports across docs

This commit is contained in:
Shahed Nasser
2024-12-09 15:10:38 +02:00
parent 8dedb97e40
commit f4b45b8080
21 changed files with 61 additions and 61 deletions
@@ -64,7 +64,7 @@ To do that, use the middleware route object defined in `src/api/middlewares.ts`.
For example, create the file `src/api/middlewares.ts` with the following content:
```ts title="src/api/middlewares.ts"
import { defineMiddlewares } from "@medusajs/medusa"
import { defineMiddlewares } from "@medusajs/framework/http"
import { z } from "zod"
export default defineMiddlewares({
@@ -81,7 +81,7 @@ For example:
export const highlights = [["25", "parseCorsOrigins", "A utility function that parses the CORS configurations in `medusa-config.ts`"]]
```ts title="src/api/middlewares.ts" highlights={highlights} collapsibleLines="1-10" expandButtonLabel="Show Imports"
import { defineMiddlewares } from "@medusajs/medusa"
import { defineMiddlewares } from "@medusajs/framework/http"
import type {
MedusaNextFunction,
MedusaRequest,
@@ -22,13 +22,13 @@ As Medusa's server is based on Express, you can use any [Express middleware](htt
## How to Create a Middleware?
Middlewares are defined in the special file `src/api/middlewares.ts`. Use the `defineMiddlewares` function imported from `@medusajs/medusa` to define the middlewares, and export its value.
Middlewares are defined in the special file `src/api/middlewares.ts`. Use the `defineMiddlewares` function from the Medusa Framework to define the middlewares, and export its value.
For example:
```ts title="src/api/middlewares.ts"
import { defineMiddlewares } from "@medusajs/medusa"
import type {
defineMiddlewares,
MedusaNextFunction,
MedusaRequest,
MedusaResponse,
@@ -118,11 +118,11 @@ For example:
export const pathParamHighlights = [["11", ":id", "Indicates that the API route accepts an `id` path parameter."]]
```ts title="src/api/middlewares.ts" collapsibleLines="1-7" expandMoreLabel="Show Imports" highlights={pathParamHighlights}
import { defineMiddlewares } from "@medusajs/medusa"
import type {
MedusaNextFunction,
MedusaRequest,
MedusaResponse,
defineMiddlewares,
} from "@medusajs/framework/http"
export default defineMiddlewares({
@@ -150,11 +150,11 @@ For example:
export const highlights = [["12", "method", "Apply the middleware only on `POST` requests"]]
```ts title="src/api/middlewares.ts" highlights={highlights} collapsibleLines="1-7" expandButtonLabel="Show Imports"
import { defineMiddlewares } from "@medusajs/medusa"
import type {
MedusaNextFunction,
MedusaRequest,
MedusaResponse,
defineMiddlewares,
} from "@medusajs/framework/http"
export default defineMiddlewares({
@@ -183,11 +183,11 @@ A middleware whose `matcher` pattern doesn't end with a backslash won't be appli
For example, consider you have the following middleware:
```ts collapsibleLines="1-7" expandMoreLabel="Show Imports"
import { defineMiddlewares } from "@medusajs/medusa"
import type {
MedusaNextFunction,
MedusaRequest,
MedusaResponse,
defineMiddlewares,
} from "@medusajs/framework/http"
export default defineMiddlewares({
@@ -49,7 +49,7 @@ export const highlights = [
import {
defineMiddlewares,
authenticate,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
export default defineMiddlewares({
routes: [
@@ -53,8 +53,8 @@ To use this schema for validating the body parameters of requests to `/custom`,
For example, create the file `src/api/middlewares.ts` with the following content:
```ts title="src/api/middlewares.ts"
import { defineMiddlewares } from "@medusajs/medusa"
import {
defineMiddlewares,
validateAndTransformBody,
} from "@medusajs/framework/http"
import { PostStoreCustomSchema } from "./custom/validators"
@@ -183,9 +183,9 @@ Next, you'll use the schema to validate incoming requests' query parameters to t
Add the `validateAndTransformQuery` middleware to the API route in the file `src/api/middlewares.ts`:
```ts title="src/api/middlewares.ts"
import { defineMiddlewares } from "@medusajs/medusa"
import {
validateAndTransformQuery,
defineMiddlewares
} from "@medusajs/framework/http"
import { PostStoreCustomSchema } from "./custom/validators"
@@ -298,9 +298,9 @@ Using this middleware allows you to have default configurations for retrieved fi
The first step is to use the `validateAndTransformQuery` middleware on the `GET` route. You add the middleware in `src/api/middlewares.ts`:
```ts title="src/api/middlewares.ts"
import { defineMiddlewares } from "@medusajs/medusa"
import {
validateAndTransformQuery,
defineMiddlewares
} from "@medusajs/framework/http"
import { createFindParams } from "@medusajs/medusa/api/utils/validators"