From eb331a4bcaa1a38954581be8e630ecf2907c75bf Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 13 Aug 2024 09:37:24 +0300 Subject: [PATCH] chore(medusa,types): [5] Add request types to API routes (#8562) * chore(medusa,types): [5] Add request types to API routes * more types --- .../types/src/http/claim/admin/responses.ts | 21 +++++++++++++++++++ .../api/admin/api-keys/[id]/revoke/route.ts | 3 ++- .../src/api/admin/api-keys/[id]/route.ts | 7 ++++--- .../api-keys/[id]/sales-channels/route.ts | 4 ++-- .../medusa/src/api/admin/api-keys/route.ts | 9 ++++---- .../admin/campaigns/[id]/promotions/route.ts | 4 ++-- .../src/api/admin/campaigns/[id]/route.ts | 8 +++---- .../medusa/src/api/admin/campaigns/route.ts | 6 +++--- .../src/api/admin/claims/[id]/cancel/route.ts | 5 +++-- .../[id]/claim-items/[action_id]/route.ts | 5 +++-- .../admin/claims/[id]/claim-items/route.ts | 3 ++- .../[id]/inbound/items/[action_id]/route.ts | 5 +++-- .../admin/claims/[id]/inbound/items/route.ts | 3 ++- .../shipping-method/[action_id]/route.ts | 5 +++-- .../[id]/inbound/shipping-method/route.ts | 3 ++- .../[id]/outbound/items/[action_id]/route.ts | 5 +++-- .../admin/claims/[id]/outbound/items/route.ts | 3 ++- .../shipping-method/[action_id]/route.ts | 5 +++-- .../[id]/outbound/shipping-method/route.ts | 3 ++- .../api/admin/claims/[id]/request/route.ts | 5 +++-- packages/medusa/src/api/admin/claims/route.ts | 5 +++-- 21 files changed, 77 insertions(+), 40 deletions(-) diff --git a/packages/core/types/src/http/claim/admin/responses.ts b/packages/core/types/src/http/claim/admin/responses.ts index 595959f59a..539703dc4b 100644 --- a/packages/core/types/src/http/claim/admin/responses.ts +++ b/packages/core/types/src/http/claim/admin/responses.ts @@ -1,4 +1,6 @@ +import { OrderDTO } from "../../../order" import { DeleteResponse, PaginatedResponse } from "../../common" +import { AdminReturn } from "../../return" import { AdminClaim } from "./entities" export interface AdminClaimResponse { @@ -10,4 +12,23 @@ export interface AdminClaimListResponse claims: AdminClaim[] }> {} +export interface AdminClaimOrderResponse { + order: OrderDTO + claim: AdminClaim +} + +export interface AdminClaimPreviewResponse { + order_preview: OrderDTO + claim: AdminClaim +} + +export interface AdminClaimReturnPreviewResponse { + order_preview: OrderDTO + return: AdminReturn +} + +export interface AdminClaimRequestResponse extends AdminClaimPreviewResponse { + return: AdminReturn +} + export interface AdminClaimDeleteResponse extends DeleteResponse<"claim"> {} diff --git a/packages/medusa/src/api/admin/api-keys/[id]/revoke/route.ts b/packages/medusa/src/api/admin/api-keys/[id]/revoke/route.ts index 6265ce2387..c41c4f25f9 100644 --- a/packages/medusa/src/api/admin/api-keys/[id]/revoke/route.ts +++ b/packages/medusa/src/api/admin/api-keys/[id]/revoke/route.ts @@ -5,10 +5,11 @@ import { } from "../../../../../types/routing" import { AdminRevokeApiKeyType } from "../../validators" import { refetchApiKey } from "../../helpers" +import { HttpTypes } from "@medusajs/types" export const POST = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { await revokeApiKeysWorkflow(req.scope).run({ input: { diff --git a/packages/medusa/src/api/admin/api-keys/[id]/route.ts b/packages/medusa/src/api/admin/api-keys/[id]/route.ts index abd375f249..9bbff4618b 100644 --- a/packages/medusa/src/api/admin/api-keys/[id]/route.ts +++ b/packages/medusa/src/api/admin/api-keys/[id]/route.ts @@ -10,10 +10,11 @@ import { import { refetchApiKey } from "../helpers" import { AdminUpdateApiKeyType } from "../validators" import { MedusaError } from "@medusajs/utils" +import { DeleteResponse, HttpTypes } from "@medusajs/types" export const GET = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const apiKey = await refetchApiKey( req.params.id, @@ -33,7 +34,7 @@ export const GET = async ( export const POST = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { await updateApiKeysWorkflow(req.scope).run({ input: { @@ -53,7 +54,7 @@ export const POST = async ( export const DELETE = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse> ) => { const id = req.params.id diff --git a/packages/medusa/src/api/admin/api-keys/[id]/sales-channels/route.ts b/packages/medusa/src/api/admin/api-keys/[id]/sales-channels/route.ts index 9e2649165c..be575bf8ab 100644 --- a/packages/medusa/src/api/admin/api-keys/[id]/sales-channels/route.ts +++ b/packages/medusa/src/api/admin/api-keys/[id]/sales-channels/route.ts @@ -1,5 +1,5 @@ import { linkSalesChannelsToApiKeyWorkflow } from "@medusajs/core-flows" -import { LinkMethodRequest } from "@medusajs/types" +import { HttpTypes, LinkMethodRequest } from "@medusajs/types" import { ApiKeyType, MedusaError } from "@medusajs/utils" import { AuthenticatedMedusaRequest, @@ -9,7 +9,7 @@ import { refetchApiKey } from "../../helpers" export const POST = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const { add, remove } = req.validatedBody const apiKey = await refetchApiKey(req.params.id, req.scope, ["id", "type"]) diff --git a/packages/medusa/src/api/admin/api-keys/route.ts b/packages/medusa/src/api/admin/api-keys/route.ts index e16479512b..4f162fc2e0 100644 --- a/packages/medusa/src/api/admin/api-keys/route.ts +++ b/packages/medusa/src/api/admin/api-keys/route.ts @@ -1,4 +1,4 @@ -import {createApiKeysWorkflow} from "@medusajs/core-flows" +import { createApiKeysWorkflow } from "@medusajs/core-flows" import { ContainerRegistrationKeys, remoteQueryObjectFromString, @@ -7,11 +7,12 @@ import { AuthenticatedMedusaRequest, MedusaResponse, } from "../../../types/routing" -import {AdminCreateApiKeyType} from "./validators" +import { AdminCreateApiKeyType } from "./validators" +import { HttpTypes } from "@medusajs/types" export const GET = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY) @@ -36,7 +37,7 @@ export const GET = async ( export const POST = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const input = [ { diff --git a/packages/medusa/src/api/admin/campaigns/[id]/promotions/route.ts b/packages/medusa/src/api/admin/campaigns/[id]/promotions/route.ts index 4479322577..f8d5607625 100644 --- a/packages/medusa/src/api/admin/campaigns/[id]/promotions/route.ts +++ b/packages/medusa/src/api/admin/campaigns/[id]/promotions/route.ts @@ -4,12 +4,12 @@ import { } from "../../../../../types/routing" import { addOrRemoveCampaignPromotionsWorkflow } from "@medusajs/core-flows" -import { LinkMethodRequest } from "@medusajs/types" +import { HttpTypes, LinkMethodRequest } from "@medusajs/types" import { refetchCampaign } from "../../helpers" export const POST = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const { id } = req.params const { add, remove } = req.validatedBody diff --git a/packages/medusa/src/api/admin/campaigns/[id]/route.ts b/packages/medusa/src/api/admin/campaigns/[id]/route.ts index 7347ed7bca..c21fd68273 100644 --- a/packages/medusa/src/api/admin/campaigns/[id]/route.ts +++ b/packages/medusa/src/api/admin/campaigns/[id]/route.ts @@ -10,11 +10,11 @@ import { import { refetchCampaign } from "../helpers" import { AdminUpdateCampaignType } from "../validators" import { MedusaError } from "@medusajs/utils" -import { AdditionalData } from "@medusajs/types" +import { AdditionalData, DeleteResponse, HttpTypes } from "@medusajs/types" export const GET = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const campaign = await refetchCampaign( req.params.id, @@ -34,7 +34,7 @@ export const GET = async ( export const POST = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const { additional_data, ...rest } = req.validatedBody const updateCampaigns = updateCampaignsWorkflow(req.scope) @@ -59,7 +59,7 @@ export const POST = async ( export const DELETE = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse> ) => { const id = req.params.id const deleteCampaigns = deleteCampaignsWorkflow(req.scope) diff --git a/packages/medusa/src/api/admin/campaigns/route.ts b/packages/medusa/src/api/admin/campaigns/route.ts index f98d1369a7..bf91ff7676 100644 --- a/packages/medusa/src/api/admin/campaigns/route.ts +++ b/packages/medusa/src/api/admin/campaigns/route.ts @@ -9,11 +9,11 @@ import { } from "@medusajs/utils" import { AdminCreateCampaignType } from "./validators" import { refetchCampaign } from "./helpers" -import { AdditionalData } from "@medusajs/types" +import { AdditionalData, HttpTypes } from "@medusajs/types" export const GET = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY) @@ -38,7 +38,7 @@ export const GET = async ( export const POST = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const { additional_data, ...rest } = req.validatedBody const createCampaigns = createCampaignsWorkflow(req.scope) diff --git a/packages/medusa/src/api/admin/claims/[id]/cancel/route.ts b/packages/medusa/src/api/admin/claims/[id]/cancel/route.ts index 70f2887a18..d41a6837c1 100644 --- a/packages/medusa/src/api/admin/claims/[id]/cancel/route.ts +++ b/packages/medusa/src/api/admin/claims/[id]/cancel/route.ts @@ -4,10 +4,11 @@ import { MedusaResponse, } from "../../../../../types/routing" import { AdminPostCancelClaimReqSchemaType } from "../../validators" +import { HttpTypes } from "@medusajs/types" export const POST = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const { id } = req.params @@ -19,5 +20,5 @@ export const POST = async ( }, }) - res.status(200).json({ claim: result }) + res.status(200).json({ claim: result as HttpTypes.AdminClaim }) } diff --git a/packages/medusa/src/api/admin/claims/[id]/claim-items/[action_id]/route.ts b/packages/medusa/src/api/admin/claims/[id]/claim-items/[action_id]/route.ts index e906be85ae..8acffa0ba0 100644 --- a/packages/medusa/src/api/admin/claims/[id]/claim-items/[action_id]/route.ts +++ b/packages/medusa/src/api/admin/claims/[id]/claim-items/[action_id]/route.ts @@ -11,10 +11,11 @@ import { MedusaResponse, } from "../../../../../../types/routing" import { AdminPostClaimsItemsActionReqSchemaType } from "../../../validators" +import { HttpTypes } from "@medusajs/types" export const POST = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const { id, action_id } = req.params @@ -49,7 +50,7 @@ export const POST = async ( export const DELETE = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY) diff --git a/packages/medusa/src/api/admin/claims/[id]/claim-items/route.ts b/packages/medusa/src/api/admin/claims/[id]/claim-items/route.ts index 4284c82176..d022e6e6b7 100644 --- a/packages/medusa/src/api/admin/claims/[id]/claim-items/route.ts +++ b/packages/medusa/src/api/admin/claims/[id]/claim-items/route.ts @@ -8,10 +8,11 @@ import { MedusaResponse, } from "../../../../../types/routing" import { AdminPostClaimItemsReqSchemaType } from "../../validators" +import { HttpTypes } from "@medusajs/types" export const POST = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const { id } = req.params diff --git a/packages/medusa/src/api/admin/claims/[id]/inbound/items/[action_id]/route.ts b/packages/medusa/src/api/admin/claims/[id]/inbound/items/[action_id]/route.ts index 55b4133aa8..7a442e3b83 100644 --- a/packages/medusa/src/api/admin/claims/[id]/inbound/items/[action_id]/route.ts +++ b/packages/medusa/src/api/admin/claims/[id]/inbound/items/[action_id]/route.ts @@ -13,10 +13,11 @@ import { import { refetchEntity } from "../../../../../../utils/refetch-entity" import { defaultAdminDetailsReturnFields } from "../../../../../returns/query-config" import { AdminPostReturnsRequestItemsActionReqSchemaType } from "../../../../../returns/validators" +import { HttpTypes } from "@medusajs/types" export const POST = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const { id, action_id } = req.params @@ -63,7 +64,7 @@ export const POST = async ( export const DELETE = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const { id, action_id } = req.params diff --git a/packages/medusa/src/api/admin/claims/[id]/inbound/items/route.ts b/packages/medusa/src/api/admin/claims/[id]/inbound/items/route.ts index 15b25916b3..4cf2ad5cd3 100644 --- a/packages/medusa/src/api/admin/claims/[id]/inbound/items/route.ts +++ b/packages/medusa/src/api/admin/claims/[id]/inbound/items/route.ts @@ -10,10 +10,11 @@ import { } from "../../../../../../types/routing" import { defaultAdminDetailsReturnFields } from "../../../../returns/query-config" import { AdminPostReturnsRequestItemsReqSchemaType } from "../../../../returns/validators" +import { HttpTypes } from "@medusajs/types" export const POST = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const { id } = req.params diff --git a/packages/medusa/src/api/admin/claims/[id]/inbound/shipping-method/[action_id]/route.ts b/packages/medusa/src/api/admin/claims/[id]/inbound/shipping-method/[action_id]/route.ts index 7c2dc2a595..ff9058bd90 100644 --- a/packages/medusa/src/api/admin/claims/[id]/inbound/shipping-method/[action_id]/route.ts +++ b/packages/medusa/src/api/admin/claims/[id]/inbound/shipping-method/[action_id]/route.ts @@ -12,10 +12,11 @@ import { } from "../../../../../../../types/routing" import { defaultAdminDetailsReturnFields } from "../../../../../returns/query-config" import { AdminPostClaimsShippingActionReqSchemaType } from "../../../../validators" +import { HttpTypes } from "@medusajs/types" export const POST = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const { id, action_id } = req.params @@ -64,7 +65,7 @@ export const POST = async ( export const DELETE = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY) diff --git a/packages/medusa/src/api/admin/claims/[id]/inbound/shipping-method/route.ts b/packages/medusa/src/api/admin/claims/[id]/inbound/shipping-method/route.ts index 0797e6155c..fd6e56eb8f 100644 --- a/packages/medusa/src/api/admin/claims/[id]/inbound/shipping-method/route.ts +++ b/packages/medusa/src/api/admin/claims/[id]/inbound/shipping-method/route.ts @@ -10,10 +10,11 @@ import { } from "../../../../../../types/routing" import { defaultAdminDetailsReturnFields } from "../../../../returns/query-config" import { AdminPostReturnsShippingReqSchemaType } from "../../../../returns/validators" +import { HttpTypes } from "@medusajs/types" export const POST = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const { id } = req.params diff --git a/packages/medusa/src/api/admin/claims/[id]/outbound/items/[action_id]/route.ts b/packages/medusa/src/api/admin/claims/[id]/outbound/items/[action_id]/route.ts index 1bebaad562..414fa576d9 100644 --- a/packages/medusa/src/api/admin/claims/[id]/outbound/items/[action_id]/route.ts +++ b/packages/medusa/src/api/admin/claims/[id]/outbound/items/[action_id]/route.ts @@ -11,10 +11,11 @@ import { MedusaResponse, } from "../../../../../../../types/routing" import { AdminPostClaimsItemsActionReqSchemaType } from "../../../../validators" +import { HttpTypes } from "@medusajs/types" export const POST = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const { id, action_id } = req.params @@ -49,7 +50,7 @@ export const POST = async ( export const DELETE = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY) diff --git a/packages/medusa/src/api/admin/claims/[id]/outbound/items/route.ts b/packages/medusa/src/api/admin/claims/[id]/outbound/items/route.ts index 70539affa7..74c056081a 100644 --- a/packages/medusa/src/api/admin/claims/[id]/outbound/items/route.ts +++ b/packages/medusa/src/api/admin/claims/[id]/outbound/items/route.ts @@ -9,10 +9,11 @@ import { MedusaResponse, } from "../../../../../../types/routing" import { AdminPostClaimsAddItemsReqSchemaType } from "../../../validators" +import { HttpTypes } from "@medusajs/types" export const POST = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const { id } = req.params diff --git a/packages/medusa/src/api/admin/claims/[id]/outbound/shipping-method/[action_id]/route.ts b/packages/medusa/src/api/admin/claims/[id]/outbound/shipping-method/[action_id]/route.ts index ddc4dda13e..07a4ced3f7 100644 --- a/packages/medusa/src/api/admin/claims/[id]/outbound/shipping-method/[action_id]/route.ts +++ b/packages/medusa/src/api/admin/claims/[id]/outbound/shipping-method/[action_id]/route.ts @@ -11,10 +11,11 @@ import { MedusaResponse, } from "../../../../../../../types/routing" import { AdminPostClaimsShippingActionReqSchemaType } from "../../../../validators" +import { HttpTypes } from "@medusajs/types" export const POST = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const { id, action_id } = req.params @@ -49,7 +50,7 @@ export const POST = async ( export const DELETE = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY) diff --git a/packages/medusa/src/api/admin/claims/[id]/outbound/shipping-method/route.ts b/packages/medusa/src/api/admin/claims/[id]/outbound/shipping-method/route.ts index ba1c8e21b8..ead573f3bb 100644 --- a/packages/medusa/src/api/admin/claims/[id]/outbound/shipping-method/route.ts +++ b/packages/medusa/src/api/admin/claims/[id]/outbound/shipping-method/route.ts @@ -8,10 +8,11 @@ import { MedusaResponse, } from "../../../../../../types/routing" import { AdminPostClaimsShippingReqSchemaType } from "../../../validators" +import { HttpTypes } from "@medusajs/types" export const POST = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const { id } = req.params diff --git a/packages/medusa/src/api/admin/claims/[id]/request/route.ts b/packages/medusa/src/api/admin/claims/[id]/request/route.ts index c551bb36dc..2080620333 100644 --- a/packages/medusa/src/api/admin/claims/[id]/request/route.ts +++ b/packages/medusa/src/api/admin/claims/[id]/request/route.ts @@ -11,10 +11,11 @@ import { MedusaResponse, } from "../../../../../types/routing" import { defaultAdminDetailsReturnFields } from "../../../returns/query-config" +import { HttpTypes } from "@medusajs/types" export const POST = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const { id } = req.params @@ -62,7 +63,7 @@ export const POST = async ( export const DELETE = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const { id } = req.params diff --git a/packages/medusa/src/api/admin/claims/route.ts b/packages/medusa/src/api/admin/claims/route.ts index 24d1ba55e2..fba9dfa35f 100644 --- a/packages/medusa/src/api/admin/claims/route.ts +++ b/packages/medusa/src/api/admin/claims/route.ts @@ -10,10 +10,11 @@ import { MedusaResponse, } from "../../../types/routing" import { AdminPostOrderClaimsReqSchemaType } from "./validators" +import { HttpTypes } from "@medusajs/types" export const GET = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY) @@ -40,7 +41,7 @@ export const GET = async ( export const POST = async ( req: AuthenticatedMedusaRequest, - res: MedusaResponse + res: MedusaResponse ) => { const input = req.validatedBody as AdminPostOrderClaimsReqSchemaType const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY)