From c962283281c888c099a7d19c4a342b7d8560fec0 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Mon, 9 Sep 2024 09:59:43 +0300 Subject: [PATCH] fix(types, medusa): request / response types clean-up (#9043) More clean-up of request / response types --- .../modules/__tests__/fixtures/fulfillment/index.ts | 1 - packages/core/types/src/http/claim/common.ts | 2 +- packages/core/types/src/http/currency/common.ts | 3 --- packages/core/types/src/tax/common.ts | 2 +- packages/core/types/src/tax/mutations.ts | 2 +- .../medusa/src/api/admin/fulfillments/[id]/cancel/route.ts | 3 +-- packages/medusa/src/api/admin/fulfillments/middlewares.ts | 2 -- packages/medusa/src/api/admin/fulfillments/validators.ts | 4 ---- packages/medusa/src/api/admin/orders/[id]/archive/route.ts | 5 ++--- packages/medusa/src/api/admin/orders/middlewares.ts | 2 -- packages/medusa/src/api/admin/orders/validators.ts | 5 ----- packages/medusa/src/api/store/carts/[id]/complete/route.ts | 3 +-- packages/medusa/src/api/store/carts/middlewares.ts | 2 -- packages/medusa/src/api/store/carts/validators.ts | 7 ------- 14 files changed, 7 insertions(+), 36 deletions(-) diff --git a/integration-tests/modules/__tests__/fixtures/fulfillment/index.ts b/integration-tests/modules/__tests__/fixtures/fulfillment/index.ts index 6d92aa5a8d..ee670c4e8f 100644 --- a/integration-tests/modules/__tests__/fixtures/fulfillment/index.ts +++ b/integration-tests/modules/__tests__/fixtures/fulfillment/index.ts @@ -49,7 +49,6 @@ export function generateCreateFulfillmentData( label_url: "test-label-url_" + randomString, }, ], - order: data.order ?? {}, order_id: data.order_id, } } diff --git a/packages/core/types/src/http/claim/common.ts b/packages/core/types/src/http/claim/common.ts index 9fe96fed36..69aa9ff8d2 100644 --- a/packages/core/types/src/http/claim/common.ts +++ b/packages/core/types/src/http/claim/common.ts @@ -21,7 +21,7 @@ export interface BaseClaim extends Omit { order_id: string claim_items: BaseClaimItem[] - additional_items: any[] + additional_items: BaseClaimItem[] return?: ReturnDTO return_id?: string no_notification?: boolean diff --git a/packages/core/types/src/http/currency/common.ts b/packages/core/types/src/http/currency/common.ts index 239f81d488..d9e1ef8b7f 100644 --- a/packages/core/types/src/http/currency/common.ts +++ b/packages/core/types/src/http/currency/common.ts @@ -1,5 +1,3 @@ -import { RawRounding } from "../../common" - export interface BaseCurrency { code: string symbol: string @@ -7,7 +5,6 @@ export interface BaseCurrency { name: string decimal_digits: number rounding: number - raw_rounding: RawRounding created_at: string updated_at: string deleted_at: string | null diff --git a/packages/core/types/src/tax/common.ts b/packages/core/types/src/tax/common.ts index eae5e75874..a6e9264461 100644 --- a/packages/core/types/src/tax/common.ts +++ b/packages/core/types/src/tax/common.ts @@ -43,7 +43,7 @@ export interface TaxRateDTO { /** * Whether the tax rate should be combined with parent rates. * - * Learn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates). + * Learn more [here](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates). */ is_combinable: boolean diff --git a/packages/core/types/src/tax/mutations.ts b/packages/core/types/src/tax/mutations.ts index 0f7ee0ee64..0d4a73c561 100644 --- a/packages/core/types/src/tax/mutations.ts +++ b/packages/core/types/src/tax/mutations.ts @@ -129,7 +129,7 @@ export interface UpdateTaxRateDTO { /** * Whether the tax rate is combinable. * - * Learn more [here](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#combinable-tax-rates). + * Learn more [here](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates). */ is_combinable?: boolean diff --git a/packages/medusa/src/api/admin/fulfillments/[id]/cancel/route.ts b/packages/medusa/src/api/admin/fulfillments/[id]/cancel/route.ts index 7ac4370d71..5261475c1d 100644 --- a/packages/medusa/src/api/admin/fulfillments/[id]/cancel/route.ts +++ b/packages/medusa/src/api/admin/fulfillments/[id]/cancel/route.ts @@ -4,11 +4,10 @@ import { MedusaResponse, } from "../../../../../types/routing" import { refetchFulfillment } from "../../helpers" -import { AdminCancelFulfillmentType } from "../../validators" import { HttpTypes } from "@medusajs/types" export const POST = async ( - req: AuthenticatedMedusaRequest, + req: AuthenticatedMedusaRequest, res: MedusaResponse ) => { const { id } = req.params diff --git a/packages/medusa/src/api/admin/fulfillments/middlewares.ts b/packages/medusa/src/api/admin/fulfillments/middlewares.ts index af5a1643d4..7951b5824b 100644 --- a/packages/medusa/src/api/admin/fulfillments/middlewares.ts +++ b/packages/medusa/src/api/admin/fulfillments/middlewares.ts @@ -3,7 +3,6 @@ import { validateAndTransformBody } from "../../utils/validate-body" import { validateAndTransformQuery } from "../../utils/validate-query" import * as QueryConfig from "./query-config" import { - AdminCancelFulfillment, AdminCreateFulfillment, AdminCreateShipment, AdminFulfillmentParams, @@ -14,7 +13,6 @@ export const adminFulfillmentsRoutesMiddlewares: MiddlewareRoute[] = [ method: ["POST"], matcher: "/admin/fulfillments/:id/cancel", middlewares: [ - validateAndTransformBody(AdminCancelFulfillment), validateAndTransformQuery( AdminFulfillmentParams, QueryConfig.retrieveTransformQueryConfig diff --git a/packages/medusa/src/api/admin/fulfillments/validators.ts b/packages/medusa/src/api/admin/fulfillments/validators.ts index ac82fe680f..5dc1e59e97 100644 --- a/packages/medusa/src/api/admin/fulfillments/validators.ts +++ b/packages/medusa/src/api/admin/fulfillments/validators.ts @@ -19,9 +19,6 @@ const AdminCreateFulfillmentLabel = z.object({ label_url: z.string(), }) -export type AdminCancelFulfillmentType = z.infer -export const AdminCancelFulfillment = z.object({}) - export type AdminCreateFulfillmentType = z.infer // TODO: revisit the data shape this endpoint accepts export const AdminCreateFulfillment = z.object({ @@ -30,7 +27,6 @@ export const AdminCreateFulfillment = z.object({ delivery_address: AddressPayload, items: z.array(AdminCreateFulfillmentItem), labels: z.array(AdminCreateFulfillmentLabel), - order: z.object({}), order_id: z.string(), shipping_option_id: z.string().nullish(), data: z.record(z.unknown()).nullable(), diff --git a/packages/medusa/src/api/admin/orders/[id]/archive/route.ts b/packages/medusa/src/api/admin/orders/[id]/archive/route.ts index cd049fc32b..8cdf4907c1 100644 --- a/packages/medusa/src/api/admin/orders/[id]/archive/route.ts +++ b/packages/medusa/src/api/admin/orders/[id]/archive/route.ts @@ -7,18 +7,17 @@ import { AuthenticatedMedusaRequest, MedusaResponse, } from "../../../../../types/routing" -import { AdminArchiveOrderType } from "../../validators" import { HttpTypes } from "@medusajs/types" export const POST = async ( - req: AuthenticatedMedusaRequest, + req: AuthenticatedMedusaRequest, res: MedusaResponse ) => { const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY) const { id } = req.params await archiveOrderWorkflow(req.scope).run({ - input: { orderIds: [req.validatedBody.order_id] }, + input: { orderIds: [id] }, }) const queryObject = remoteQueryObjectFromString({ diff --git a/packages/medusa/src/api/admin/orders/middlewares.ts b/packages/medusa/src/api/admin/orders/middlewares.ts index a6aa5cd319..e9c52c2b12 100644 --- a/packages/medusa/src/api/admin/orders/middlewares.ts +++ b/packages/medusa/src/api/admin/orders/middlewares.ts @@ -3,7 +3,6 @@ import { validateAndTransformBody } from "../../utils/validate-body" import { validateAndTransformQuery } from "../../utils/validate-query" import * as QueryConfig from "./query-config" import { - AdminArchiveOrder, AdminCompleteOrder, AdminGetOrdersOrderParams, AdminGetOrdersParams, @@ -58,7 +57,6 @@ export const adminOrderRoutesMiddlewares: MiddlewareRoute[] = [ method: ["POST"], matcher: "/admin/orders/:id/archive", middlewares: [ - validateAndTransformBody(AdminArchiveOrder), validateAndTransformQuery( AdminGetOrdersOrderParams, QueryConfig.retrieveTransformQueryConfig diff --git a/packages/medusa/src/api/admin/orders/validators.ts b/packages/medusa/src/api/admin/orders/validators.ts index 9705c7756f..9f466bf47c 100644 --- a/packages/medusa/src/api/admin/orders/validators.ts +++ b/packages/medusa/src/api/admin/orders/validators.ts @@ -47,11 +47,6 @@ export const AdminGetOrdersParams = createFindParams({ export type AdminGetOrdersParamsType = z.infer -export const AdminArchiveOrder = z.object({ - order_id: z.string(), -}) -export type AdminArchiveOrderType = z.infer - export const AdminCompleteOrder = WithAdditionalData(z.object({})) const Item = z.object({ diff --git a/packages/medusa/src/api/store/carts/[id]/complete/route.ts b/packages/medusa/src/api/store/carts/[id]/complete/route.ts index d0d571c1e0..5cba87d148 100644 --- a/packages/medusa/src/api/store/carts/[id]/complete/route.ts +++ b/packages/medusa/src/api/store/carts/[id]/complete/route.ts @@ -5,11 +5,10 @@ import { prepareRetrieveQuery } from "../../../../../utils/get-query-config" import { refetchOrder } from "../../../orders/helpers" import { refetchCart } from "../../helpers" import { defaultStoreCartFields } from "../../query-config" -import { StoreCompleteCartType } from "../../validators" import { HttpTypes } from "@medusajs/types" export const POST = async ( - req: MedusaRequest, + req: MedusaRequest, res: MedusaResponse ) => { const cart_id = req.params.id diff --git a/packages/medusa/src/api/store/carts/middlewares.ts b/packages/medusa/src/api/store/carts/middlewares.ts index e2a486e8c9..32696ee44c 100644 --- a/packages/medusa/src/api/store/carts/middlewares.ts +++ b/packages/medusa/src/api/store/carts/middlewares.ts @@ -11,7 +11,6 @@ import { StoreAddCartPromotions, StoreAddCartShippingMethods, StoreCalculateCartTaxes, - StoreCompleteCart, StoreCreateCart, StoreGetCartsCart, StoreRemoveCartPromotions, @@ -134,7 +133,6 @@ export const storeCartRoutesMiddlewares: MiddlewareRoute[] = [ method: ["POST"], matcher: "/store/carts/:id/complete", middlewares: [ - validateAndTransformBody(StoreCompleteCart), validateAndTransformQuery( StoreGetOrderParams, OrderQueryConfig.retrieveTransformQueryConfig diff --git a/packages/medusa/src/api/store/carts/validators.ts b/packages/medusa/src/api/store/carts/validators.ts index 953d20a9b3..fd79bd35bd 100644 --- a/packages/medusa/src/api/store/carts/validators.ts +++ b/packages/medusa/src/api/store/carts/validators.ts @@ -86,13 +86,6 @@ export const StoreAddCartShippingMethods = z }) .strict() -export const StoreCompleteCart = z - .object({ - idempotency_key: z.string().optional(), - }) - .strict() -export type StoreCompleteCartType = z.infer - export type StoreCreateCartPaymentCollectionType = z.infer< typeof StoreCreateCartPaymentCollection >