docs: update imports of middlewares and http types (#9440)

This commit is contained in:
Shahed Nasser
2024-10-03 15:56:58 +00:00
committed by GitHub
parent a461e21ae7
commit 00a51b59b1
71 changed files with 213 additions and 213 deletions
@@ -52,7 +52,7 @@ For example:
import type {
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
export const GET = (
req: MedusaRequest,
@@ -86,7 +86,7 @@ import type {
MedusaNextFunction,
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
import { ConfigModule } from "@medusajs/framework/types"
import { parseCorsOrigins } from "@medusajs/framework/utils"
import cors from "cors"
@@ -17,7 +17,7 @@ The Medusa application's API route error handler then wraps your thrown error in
For example:
```ts
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http"
import { MedusaError } from "@medusajs/framework/utils"
export const GET = async (
@@ -257,7 +257,7 @@ import {
MedusaNextFunction,
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
import { MedusaError } from "@medusajs/framework/utils"
export default defineMiddlewares({
@@ -18,7 +18,7 @@ For example, create the file `src/api/hello-world/route.ts` with the following c
import type {
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
export const GET = async (
req: MedusaRequest,
@@ -32,7 +32,7 @@ import type {
MedusaNextFunction,
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
export default defineMiddlewares({
routes: [
@@ -123,7 +123,7 @@ import type {
MedusaNextFunction,
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
export default defineMiddlewares({
routes: [
@@ -155,7 +155,7 @@ import type {
MedusaNextFunction,
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
export default defineMiddlewares({
routes: [
@@ -188,7 +188,7 @@ import type {
MedusaNextFunction,
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
export default defineMiddlewares({
routes: [
@@ -20,7 +20,7 @@ export const singlePathHighlights = [
import type {
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
export const GET = async (
req: MedusaRequest,
@@ -49,7 +49,7 @@ export const multiplePathHighlights = [
import type {
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
export const GET = async (
req: MedusaRequest,
@@ -81,7 +81,7 @@ export const queryHighlights = [
import type {
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
export const GET = async (
req: MedusaRequest,
@@ -112,7 +112,7 @@ export const bodyHighlights = [
import type {
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
type HelloWorldReq = {
name: string
@@ -84,7 +84,7 @@ For example:
import type {
AuthenticatedMedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
export const GET = async (
req: AuthenticatedMedusaRequest,
@@ -124,7 +124,7 @@ For example:
import type {
AuthenticatedMedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
import { Modules } from "@medusajs/framework/utils"
import { ICustomerModuleService } from "@medusajs/framework/types"
@@ -159,7 +159,7 @@ For example:
import type {
AuthenticatedMedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
import { Modules } from "@medusajs/framework/utils"
import { IUserModuleService } from "@medusajs/framework/types"
@@ -17,7 +17,7 @@ export const jsonHighlights = [
]
```ts title="src/api/custom/route.ts" highlights={jsonHighlights}
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http"
export const GET = async (
req: MedusaRequest,
@@ -52,7 +52,7 @@ export const statusHighlight = [
]
```ts title="src/api/custom/route.ts" highlights={statusHighlight}
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http"
export const GET = async (
req: MedusaRequest,
@@ -84,7 +84,7 @@ export const streamHighlights = [
]
```ts highlights={streamHighlights}
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http"
export const GET = async (
req: MedusaRequest,
@@ -41,7 +41,7 @@ The `PostStoreCustomSchema` variable is a Zod schema that indicates the request
## Step 2: Add Validation Middleware
To use this schema for validating the body parameters of requests to `/custom`, use the `validateAndTransformBody` middleware provided by `@medusajs/medusa`. It accepts the Zod schema as a parameter.
To use this schema for validating the body parameters of requests to `/custom`, use the `validateAndTransformBody` middleware provided by `@medusajs/framework/utils`. It accepts the Zod schema as a parameter.
For example, create the file `src/api/middlewares.ts` with the following content:
@@ -49,7 +49,7 @@ For example, create the file `src/api/middlewares.ts` with the following content
import { defineMiddlewares } from "@medusajs/medusa"
import {
validateAndTransformBody,
} from "@medusajs/medusa/api/utils/validate-body"
} from "@medusajs/framework/utils"
import { PostStoreCustomSchema } from "./custom/validators"
export default defineMiddlewares({
@@ -87,7 +87,7 @@ export const routeHighlights = [
]
```ts title="src/api/custom/route.ts" highlights={routeHighlights}
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http"
import { z } from "zod"
import { PostStoreCustomSchema } from "./validators"
@@ -25,7 +25,7 @@ export const highlights = [
import type {
SubscriberArgs,
SubscriberConfig,
} from "@medusajs/medusa"
} from "@medusajs/framework"
export default async function productCreateHandler({
event,
@@ -37,7 +37,7 @@ export const exampleHighlights = [
import {
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
import {
ContainerRegistrationKeys,
} from "@medusajs/framework/utils"
@@ -18,7 +18,7 @@ For example:
import {
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
import {
ContainerRegistrationKeys,
} from "@medusajs/framework/utils"
@@ -23,7 +23,7 @@ export const highlights = [
import type {
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
import myWorkflow from "../../../workflows/hello-world"
export async function GET(
@@ -91,7 +91,7 @@ Finally, execute the workflow from an API route:
import type {
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
import myWorkflow from "../../../workflows/hello-world"
export async function GET(
@@ -284,7 +284,7 @@ export const highlights = [
]
```ts title="src/api/workflows/route.ts" highlights={highlights} collapsibleLines="1-11" expandButtonLabel="Show Imports"
import type { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import type { MedusaRequest, MedusaResponse } from "@medusajs/framework/http"
import myWorkflow from "../../../workflows/hello-world"
import {
IWorkflowEngineService,
@@ -130,7 +130,7 @@ Learn how to pass `additional_data` in requests to API routes in [this chapter](
You can also pass that additional data when executing the workflow. Pass it as a parameter to the `.run` method of the workflow:
```ts title="src/workflows/hooks/product-created.ts" highlights={[["10", "additional_data"]]}
import type { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import type { MedusaRequest, MedusaResponse } from "@medusajs/framework/http"
import { createProductsWorkflow } from "@medusajs/medusa/core-flows"
export async function POST(req: MedusaRequest, res: MedusaResponse) {
+1 -1
View File
@@ -26,7 +26,7 @@ For example, to create a `GET` API Route at `/hello-world`, create the file `src
import type {
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
export const GET = (
req: MedusaRequest,
@@ -25,7 +25,7 @@ Similarly to your custom module, a commerce module's main service is registered
For example, you saw this code snippet in the [Medusa container chapter](../medusa-container/page.mdx):
```ts highlights={[["10"]]}
import type { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import type { MedusaRequest, MedusaResponse } from "@medusajs/framework/http"
import { IProductModuleService } from "@medusajs/framework/types"
import { Modules } from "@medusajs/framework/utils"
@@ -25,7 +25,7 @@ A subscriber is created in a TypeScript or JavaScript file under the `src/subscr
For example, create the file `src/subscribers/product-created.ts` with the following content:
```ts title="src/subscribers/product-created.ts"
import { type SubscriberConfig } from "@medusajs/medusa"
import { type SubscriberConfig } from "@medusajs/framework"
// subscriber function
export default async function productCreateHandler() {
@@ -89,7 +89,7 @@ export const highlights = [
]
```ts title="src/subscribers/product-created.ts" highlights={highlights}
import { SubscriberArgs, type SubscriberConfig } from "@medusajs/medusa"
import { SubscriberArgs, type SubscriberConfig } from "@medusajs/framework"
import { IProductModuleService } from "@medusajs/framework/types"
import { Modules } from "@medusajs/framework/utils"
@@ -24,7 +24,7 @@ export const highlights = [
]
```ts highlights={highlights}
import type { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import type { MedusaRequest, MedusaResponse } from "@medusajs/framework/http"
import { IProductModuleService } from "@medusajs/framework/types"
import { Modules } from "@medusajs/framework/utils"
@@ -102,7 +102,7 @@ Resolving a module's service is essential to use its methods that perform action
For example, create the API route `src/api/custom/route.ts` with the following content:
```ts title="src/api/custom/route.ts"
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http"
import HelloModuleService from "../../modules/hello/service"
import { HELLO_MODULE } from "../../modules/hello"
+2 -2
View File
@@ -100,7 +100,7 @@ To execute the workflow, invoke it passing the Medusa container as a parameter.
import type {
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
import myWorkflow from "../../../workflows/hello-world"
export async function GET(
@@ -125,7 +125,7 @@ To execute the workflow, invoke it passing the Medusa container as a parameter.
import {
type SubscriberConfig,
type SubscriberArgs,
} from "@medusajs/medusa"
} from "@medusajs/framework"
import myWorkflow from "../workflows/hello-world"
import { Modules } from "@medusajs/framework/utils"
import { IUserModuleService } from "@medusajs/framework/types"
@@ -27,7 +27,7 @@ Create the file `src/api/admin/brands/route.ts` with the following content:
import {
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
import {
CreateBrandInput,
createBrandWorkflow,
@@ -39,7 +39,7 @@ Create the file `src/api/admin/brands/route.ts` with the following content:
import {
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
import { BRAND_MODULE } from "../../../modules/brand"
import BrandModuleService from "../../../modules/brand/service"
@@ -49,7 +49,7 @@ export const highlights = [
import {
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
import {
ContainerRegistrationKeys,
} from "@medusajs/framework/utils"
@@ -170,7 +170,7 @@ To handle the `brand.created` event, create a subscriber at `src/subscribers/bra
import type {
SubscriberConfig,
SubscriberArgs,
} from "@medusajs/medusa"
} from "@medusajs/framework"
import { syncBrandToSystemWorkflow } from "../workflows/sync-brand-to-system"
export default async function brandCreatedHandler({
@@ -22,7 +22,7 @@ In this chapter, you'll learn how to write integration tests for API routes usin
Consider the following API route created at `src/api/custom/route.ts`:
```ts title="src/api/custom/route.ts"
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http"
export async function GET(
req: MedusaRequest,
@@ -223,7 +223,7 @@ The `afterAll` hook resolves the `HelloModuleService` and use its `deleteMyCusto
Consider a `/custom/:id` API route created at `src/api/custom/[id]/route.ts`:
```ts title="src/api/custom/[id]/route.ts"
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http"
import HelloModuleService from "../../../modules/hello/service"
export async function DELETE(
@@ -16,7 +16,7 @@ To create an API route, create the file `src/api/hello-world/route.ts` with the
import type {
MedusaRequest,
MedusaResponse,
} from "@medusajs/medusa"
} from "@medusajs/framework/http"
export const GET = (
req: MedusaRequest,