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

medusajs · Mar 15, 2023 · d1a2421 · d1a2421
1 parent fe9eea4
commit d1a2421
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 9 deletions.
diff --git a/.changeset/stale-mangos-retire.md b/.changeset/stale-mangos-retire.md
@@ -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
diff --git a/packages/medusa-js/src/resources/admin/store.ts b/packages/medusa-js/src/resources/admin/store.ts
@@ -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)
  }

diff --git a/packages/medusa-react/src/hooks/admin/store/queries.ts b/packages/medusa-react/src/hooks/admin/store/queries.ts
@@ -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"]>
  >

diff --git a/packages/medusa/src/api/routes/admin/store/get-store.ts b/packages/medusa/src/api/routes/admin/store/get-store.ts
@@ -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")
  }

diff --git a/packages/medusa/src/api/routes/admin/store/index.ts b/packages/medusa/src/api/routes/admin/store/index.ts
@@ -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,19 +30,34 @@ export default (app) => {
  return app
 }
 
+export const defaultRelationsExtended = ["currencies", "default_currency"]
+
 /**
- * @schema AdminStoresRes
+ * @schema AdminExtendedStoresRes
  * type: object
  * required:
  * - store
  * properties:
  * 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