fix(oas,js,react): use AdminExtendedStoresRes instead of AdminStoresRes (#3478)

## What

Declare and use AdminExtendedStoresRes for `[get] /admin/store` endpoint.

## Why

Only `[get] /admin/store` returns `ExtendedStoreDTO`. Other `/admin/store` endpoints return `Store`.

## How

* Create new AdminExtendedStoresRes OAS schema
* Update medusa-js
* Update medusa-react
This commit is contained in:
Patrick authored and GitHub committed 2023-03-15 11:17:34 +00:00
1 parent 10bf05c147
commit 6748877c69
5 files changed
+34 -9

No files matched your search

+8
View File
@@ -0,0 +1,8 @@
---
"@medusajs/client-types": patch
"medusa-react": patch
"@medusajs/medusa-js": patch
"@medusajs/medusa": patch
---
fix(oas,js,react): use AdminExtendedStoresRes instead of AdminStoresRes
@@ -1,8 +1,9 @@
import { import {
AdminExtendedStoresRes,
AdminPaymentProvidersList, AdminPaymentProvidersList,
AdminTaxProvidersList,
AdminPostStoreReq, AdminPostStoreReq,
AdminStoresRes, AdminStoresRes,
AdminTaxProvidersList,
} from "@medusajs/medusa" } from "@medusajs/medusa"
import { ResponsePromise } from "../../typings" import { ResponsePromise } from "../../typings"
import BaseResource from "../base" import BaseResource from "../base"
@@ -56,7 +57,7 @@ class AdminStoresResource extends BaseResource {
*/ */
retrieve( retrieve(
customHeaders: Record<string, any> = {} customHeaders: Record<string, any> = {}
): ResponsePromise<AdminStoresRes> { ): ResponsePromise<AdminExtendedStoresRes> {
const path = `/admin/store/` const path = `/admin/store/`
return this.client.request("GET", path, undefined, {}, customHeaders) return this.client.request("GET", path, undefined, {}, customHeaders)
} }
@@ -1,6 +1,6 @@
import { import {
AdminExtendedStoresRes,
AdminPaymentProvidersList, AdminPaymentProvidersList,
AdminStoresRes,
AdminTaxProvidersList, AdminTaxProvidersList,
} from "@medusajs/medusa" } from "@medusajs/medusa"
import { Response } from "@medusajs/medusa-js" import { Response } from "@medusajs/medusa-js"
@@ -49,7 +49,7 @@ export const useAdminStoreTaxProviders = (
export const useAdminStore = ( export const useAdminStore = (
options?: UseQueryOptionsWrapper< options?: UseQueryOptionsWrapper<
Response<AdminStoresRes>, Response<AdminExtendedStoresRes>,
Error, Error,
ReturnType<StoreQueryKeys["details"]> ReturnType<StoreQueryKeys["details"]>
> >
@@ -6,6 +6,7 @@ import {
import { ExtendedStoreDTO } from "../../../../types/store" import { ExtendedStoreDTO } from "../../../../types/store"
import { FlagRouter } from "../../../../utils/flag-router" import { FlagRouter } from "../../../../utils/flag-router"
import { ModulesHelper } from "@medusajs/modules-sdk" import { ModulesHelper } from "@medusajs/modules-sdk"
import { defaultRelationsExtended } from "."
/** /**
* @oas [get] /admin/store * @oas [get] /admin/store
@@ -42,7 +43,7 @@ import { ModulesHelper } from "@medusajs/modules-sdk"
* content: * content:
* application/json: * application/json:
* schema: * schema:
* $ref: "#/components/schemas/AdminStoresRes" * $ref: "#/components/schemas/AdminExtendedStoresRes"
* "400": * "400":
* $ref: "#/components/responses/400_error" * $ref: "#/components/responses/400_error"
* "401": * "401":
@@ -68,7 +69,7 @@ export default async (req, res) => {
const fulfillmentProviderService: FulfillmentProviderService = const fulfillmentProviderService: FulfillmentProviderService =
req.scope.resolve("fulfillmentProviderService") req.scope.resolve("fulfillmentProviderService")
const relations = ["currencies", "default_currency"] const relations = [...defaultRelationsExtended]
if (featureFlagRouter.isFeatureEnabled("sales_channels")) { if (featureFlagRouter.isFeatureEnabled("sales_channels")) {
relations.push("default_sales_channel") relations.push("default_sales_channel")
} }
@@ -1,5 +1,5 @@
import { Router } from "express" import { Router } from "express"
import { PaymentProvider, TaxProvider } from "./../../../../" import { PaymentProvider, Store, TaxProvider } from "./../../../../"
import middlewares from "../../../middlewares" import middlewares from "../../../middlewares"
import { ExtendedStoreDTO } from "../../../../types/store" import { ExtendedStoreDTO } from "../../../../types/store"
@@ -30,8 +30,10 @@ export default (app) => {
return app return app
} }
export const defaultRelationsExtended = ["currencies", "default_currency"]
/** /**
* @schema AdminStoresRes * @schema AdminExtendedStoresRes
* type: object * type: object
* required: * required:
* - store * - store
@@ -39,10 +41,23 @@ export default (app) => {
* store: * store:
* $ref: "#/components/schemas/ExtendedStoreDTO" * $ref: "#/components/schemas/ExtendedStoreDTO"
*/ */
export type AdminStoresRes = { export type AdminExtendedStoresRes = {
store: ExtendedStoreDTO store: ExtendedStoreDTO
} }
/**
* @schema AdminStoresRes
* type: object
* required:
* - store
* properties:
* store:
* $ref: "#/components/schemas/Store"
*/
export type AdminStoresRes = {
store: Store
}
/** /**
* @schema AdminTaxProvidersList * @schema AdminTaxProvidersList
* type: object * type: object