fix(types, medusa): request / response types clean-up (#9043)

More clean-up of request / response types
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-09-09 06:59:43 +00:00
1 parent 3eb2387746
commit c962283281
14 files changed
+7 -36

No files matched your search

@@ -49,7 +49,6 @@ export function generateCreateFulfillmentData(
label_url: "test-label-url_" + randomString, label_url: "test-label-url_" + randomString,
}, },
], ],
order: data.order ?? {},
order_id: data.order_id, order_id: data.order_id,
} }
} }
+1 -1
View File
@@ -21,7 +21,7 @@ export interface BaseClaim
extends Omit<BaseOrder, "status" | "version" | "items"> { extends Omit<BaseOrder, "status" | "version" | "items"> {
order_id: string order_id: string
claim_items: BaseClaimItem[] claim_items: BaseClaimItem[]
additional_items: any[] additional_items: BaseClaimItem[]
return?: ReturnDTO return?: ReturnDTO
return_id?: string return_id?: string
no_notification?: boolean no_notification?: boolean
@@ -1,5 +1,3 @@
import { RawRounding } from "../../common"
export interface BaseCurrency { export interface BaseCurrency {
code: string code: string
symbol: string symbol: string
@@ -7,7 +5,6 @@ export interface BaseCurrency {
name: string name: string
decimal_digits: number decimal_digits: number
rounding: number rounding: number
raw_rounding: RawRounding
created_at: string created_at: string
updated_at: string updated_at: string
deleted_at: string | null deleted_at: string | null
+1 -1
View File
@@ -43,7 +43,7 @@ export interface TaxRateDTO {
/** /**
* Whether the tax rate should be combined with parent rates. * 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 is_combinable: boolean
+1 -1
View File
@@ -129,7 +129,7 @@ export interface UpdateTaxRateDTO {
/** /**
* Whether the tax rate is combinable. * 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 is_combinable?: boolean
@@ -4,11 +4,10 @@ import {
MedusaResponse, MedusaResponse,
} from "../../../../../types/routing" } from "../../../../../types/routing"
import { refetchFulfillment } from "../../helpers" import { refetchFulfillment } from "../../helpers"
import { AdminCancelFulfillmentType } from "../../validators"
import { HttpTypes } from "@medusajs/types" import { HttpTypes } from "@medusajs/types"
export const POST = async ( export const POST = async (
req: AuthenticatedMedusaRequest<AdminCancelFulfillmentType>, req: AuthenticatedMedusaRequest,
res: MedusaResponse<HttpTypes.AdminFulfillmentResponse> res: MedusaResponse<HttpTypes.AdminFulfillmentResponse>
) => { ) => {
const { id } = req.params const { id } = req.params
@@ -3,7 +3,6 @@ import { validateAndTransformBody } from "../../utils/validate-body"
import { validateAndTransformQuery } from "../../utils/validate-query" import { validateAndTransformQuery } from "../../utils/validate-query"
import * as QueryConfig from "./query-config" import * as QueryConfig from "./query-config"
import { import {
AdminCancelFulfillment,
AdminCreateFulfillment, AdminCreateFulfillment,
AdminCreateShipment, AdminCreateShipment,
AdminFulfillmentParams, AdminFulfillmentParams,
@@ -14,7 +13,6 @@ export const adminFulfillmentsRoutesMiddlewares: MiddlewareRoute[] = [
method: ["POST"], method: ["POST"],
matcher: "/admin/fulfillments/:id/cancel", matcher: "/admin/fulfillments/:id/cancel",
middlewares: [ middlewares: [
validateAndTransformBody(AdminCancelFulfillment),
validateAndTransformQuery( validateAndTransformQuery(
AdminFulfillmentParams, AdminFulfillmentParams,
QueryConfig.retrieveTransformQueryConfig QueryConfig.retrieveTransformQueryConfig
@@ -19,9 +19,6 @@ const AdminCreateFulfillmentLabel = z.object({
label_url: z.string(), label_url: z.string(),
}) })
export type AdminCancelFulfillmentType = z.infer<typeof AdminCancelFulfillment>
export const AdminCancelFulfillment = z.object({})
export type AdminCreateFulfillmentType = z.infer<typeof AdminCreateFulfillment> export type AdminCreateFulfillmentType = z.infer<typeof AdminCreateFulfillment>
// TODO: revisit the data shape this endpoint accepts // TODO: revisit the data shape this endpoint accepts
export const AdminCreateFulfillment = z.object({ export const AdminCreateFulfillment = z.object({
@@ -30,7 +27,6 @@ export const AdminCreateFulfillment = z.object({
delivery_address: AddressPayload, delivery_address: AddressPayload,
items: z.array(AdminCreateFulfillmentItem), items: z.array(AdminCreateFulfillmentItem),
labels: z.array(AdminCreateFulfillmentLabel), labels: z.array(AdminCreateFulfillmentLabel),
order: z.object({}),
order_id: z.string(), order_id: z.string(),
shipping_option_id: z.string().nullish(), shipping_option_id: z.string().nullish(),
data: z.record(z.unknown()).nullable(), data: z.record(z.unknown()).nullable(),
@@ -7,18 +7,17 @@ import {
AuthenticatedMedusaRequest, AuthenticatedMedusaRequest,
MedusaResponse, MedusaResponse,
} from "../../../../../types/routing" } from "../../../../../types/routing"
import { AdminArchiveOrderType } from "../../validators"
import { HttpTypes } from "@medusajs/types" import { HttpTypes } from "@medusajs/types"
export const POST = async ( export const POST = async (
req: AuthenticatedMedusaRequest<AdminArchiveOrderType>, req: AuthenticatedMedusaRequest,
res: MedusaResponse<HttpTypes.AdminOrderResponse> res: MedusaResponse<HttpTypes.AdminOrderResponse>
) => { ) => {
const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY) const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY)
const { id } = req.params const { id } = req.params
await archiveOrderWorkflow(req.scope).run({ await archiveOrderWorkflow(req.scope).run({
input: { orderIds: [req.validatedBody.order_id] }, input: { orderIds: [id] },
}) })
const queryObject = remoteQueryObjectFromString({ const queryObject = remoteQueryObjectFromString({
@@ -3,7 +3,6 @@ import { validateAndTransformBody } from "../../utils/validate-body"
import { validateAndTransformQuery } from "../../utils/validate-query" import { validateAndTransformQuery } from "../../utils/validate-query"
import * as QueryConfig from "./query-config" import * as QueryConfig from "./query-config"
import { import {
AdminArchiveOrder,
AdminCompleteOrder, AdminCompleteOrder,
AdminGetOrdersOrderParams, AdminGetOrdersOrderParams,
AdminGetOrdersParams, AdminGetOrdersParams,
@@ -58,7 +57,6 @@ export const adminOrderRoutesMiddlewares: MiddlewareRoute[] = [
method: ["POST"], method: ["POST"],
matcher: "/admin/orders/:id/archive", matcher: "/admin/orders/:id/archive",
middlewares: [ middlewares: [
validateAndTransformBody(AdminArchiveOrder),
validateAndTransformQuery( validateAndTransformQuery(
AdminGetOrdersOrderParams, AdminGetOrdersOrderParams,
QueryConfig.retrieveTransformQueryConfig QueryConfig.retrieveTransformQueryConfig
@@ -47,11 +47,6 @@ export const AdminGetOrdersParams = createFindParams({
export type AdminGetOrdersParamsType = z.infer<typeof AdminGetOrdersParams> export type AdminGetOrdersParamsType = z.infer<typeof AdminGetOrdersParams>
export const AdminArchiveOrder = z.object({
order_id: z.string(),
})
export type AdminArchiveOrderType = z.infer<typeof AdminArchiveOrder>
export const AdminCompleteOrder = WithAdditionalData(z.object({})) export const AdminCompleteOrder = WithAdditionalData(z.object({}))
const Item = z.object({ const Item = z.object({
@@ -5,11 +5,10 @@ import { prepareRetrieveQuery } from "../../../../../utils/get-query-config"
import { refetchOrder } from "../../../orders/helpers" import { refetchOrder } from "../../../orders/helpers"
import { refetchCart } from "../../helpers" import { refetchCart } from "../../helpers"
import { defaultStoreCartFields } from "../../query-config" import { defaultStoreCartFields } from "../../query-config"
import { StoreCompleteCartType } from "../../validators"
import { HttpTypes } from "@medusajs/types" import { HttpTypes } from "@medusajs/types"
export const POST = async ( export const POST = async (
req: MedusaRequest<StoreCompleteCartType>, req: MedusaRequest,
res: MedusaResponse<HttpTypes.StoreCompleteCartResponse> res: MedusaResponse<HttpTypes.StoreCompleteCartResponse>
) => { ) => {
const cart_id = req.params.id const cart_id = req.params.id
@@ -11,7 +11,6 @@ import {
StoreAddCartPromotions, StoreAddCartPromotions,
StoreAddCartShippingMethods, StoreAddCartShippingMethods,
StoreCalculateCartTaxes, StoreCalculateCartTaxes,
StoreCompleteCart,
StoreCreateCart, StoreCreateCart,
StoreGetCartsCart, StoreGetCartsCart,
StoreRemoveCartPromotions, StoreRemoveCartPromotions,
@@ -134,7 +133,6 @@ export const storeCartRoutesMiddlewares: MiddlewareRoute[] = [
method: ["POST"], method: ["POST"],
matcher: "/store/carts/:id/complete", matcher: "/store/carts/:id/complete",
middlewares: [ middlewares: [
validateAndTransformBody(StoreCompleteCart),
validateAndTransformQuery( validateAndTransformQuery(
StoreGetOrderParams, StoreGetOrderParams,
OrderQueryConfig.retrieveTransformQueryConfig OrderQueryConfig.retrieveTransformQueryConfig
@@ -86,13 +86,6 @@ export const StoreAddCartShippingMethods = z
}) })
.strict() .strict()
export const StoreCompleteCart = z
.object({
idempotency_key: z.string().optional(),
})
.strict()
export type StoreCompleteCartType = z.infer<typeof StoreCompleteCart>
export type StoreCreateCartPaymentCollectionType = z.infer< export type StoreCreateCartPaymentCollectionType = z.infer<
typeof StoreCreateCartPaymentCollection typeof StoreCreateCartPaymentCollection
> >