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
2023-03-15 07:17:34 -04:00
committed by GitHub
parent 10bf05c147
commit 6748877c69
5 changed files with 34 additions and 9 deletions

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

View File

@@ -1,8 +1,9 @@
import {
AdminExtendedStoresRes,
AdminPaymentProvidersList,
AdminTaxProvidersList,
AdminPostStoreReq,
AdminStoresRes,
AdminTaxProvidersList,
} from "@medusajs/medusa"
import { ResponsePromise } from "../../typings"
import BaseResource from "../base"
@@ -56,7 +57,7 @@ class AdminStoresResource extends BaseResource {
*/
retrieve(
customHeaders: Record<string, any> = {}
): ResponsePromise<AdminStoresRes> {
): ResponsePromise<AdminExtendedStoresRes> {
const path = `/admin/store/`
return this.client.request("GET", path, undefined, {}, customHeaders)
}

View File

@@ -1,6 +1,6 @@
import {
AdminExtendedStoresRes,
AdminPaymentProvidersList,
AdminStoresRes,
AdminTaxProvidersList,
} from "@medusajs/medusa"
import { Response } from "@medusajs/medusa-js"
@@ -49,7 +49,7 @@ export const useAdminStoreTaxProviders = (
export const useAdminStore = (
options?: UseQueryOptionsWrapper<
Response<AdminStoresRes>,
Response<AdminExtendedStoresRes>,
Error,
ReturnType<StoreQueryKeys["details"]>
>

View File

@@ -6,6 +6,7 @@ import {
import { ExtendedStoreDTO } from "../../../../types/store"
import { FlagRouter } from "../../../../utils/flag-router"
import { ModulesHelper } from "@medusajs/modules-sdk"
import { defaultRelationsExtended } from "."
/**
* @oas [get] /admin/store
@@ -42,7 +43,7 @@ import { ModulesHelper } from "@medusajs/modules-sdk"
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminStoresRes"
* $ref: "#/components/schemas/AdminExtendedStoresRes"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -68,7 +69,7 @@ export default async (req, res) => {
const fulfillmentProviderService: FulfillmentProviderService =
req.scope.resolve("fulfillmentProviderService")
const relations = ["currencies", "default_currency"]
const relations = [...defaultRelationsExtended]
if (featureFlagRouter.isFeatureEnabled("sales_channels")) {
relations.push("default_sales_channel")
}

View File

@@ -1,5 +1,5 @@
import { Router } from "express"
import { PaymentProvider, TaxProvider } from "./../../../../"
import { PaymentProvider, Store, TaxProvider } from "./../../../../"
import middlewares from "../../../middlewares"
import { ExtendedStoreDTO } from "../../../../types/store"
@@ -30,8 +30,10 @@ export default (app) => {
return app
}
export const defaultRelationsExtended = ["currencies", "default_currency"]
/**
* @schema AdminStoresRes
* @schema AdminExtendedStoresRes
* type: object
* required:
* - store
@@ -39,10 +41,23 @@ export default (app) => {
* store:
* $ref: "#/components/schemas/ExtendedStoreDTO"
*/
export type AdminStoresRes = {
export type AdminExtendedStoresRes = {
store: ExtendedStoreDTO
}
/**
* @schema AdminStoresRes
* type: object
* required:
* - store
* properties:
* store:
* $ref: "#/components/schemas/Store"
*/
export type AdminStoresRes = {
store: Store
}
/**
* @schema AdminTaxProvidersList
* type: object