Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Mar 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/stale-mangos-retire.md
Original file line number Diff line number Diff line change
@@ -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
5 changes: 3 additions & 2 deletions packages/medusa-js/src/resources/admin/store.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import {
AdminExtendedStoresRes,
AdminPaymentProvidersList,
AdminTaxProvidersList,
AdminPostStoreReq,
AdminStoresRes,
AdminTaxProvidersList,
} from "@medusajs/medusa"
import { ResponsePromise } from "../../typings"
import BaseResource from "../base"
Expand Down Expand Up @@ -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)
}
Expand Down
4 changes: 2 additions & 2 deletions packages/medusa-react/src/hooks/admin/store/queries.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import {
AdminExtendedStoresRes,
AdminPaymentProvidersList,
AdminStoresRes,
AdminTaxProvidersList,
} from "@medusajs/medusa"
import { Response } from "@medusajs/medusa-js"
Expand Down Expand Up @@ -49,7 +49,7 @@ export const useAdminStoreTaxProviders = (

export const useAdminStore = (
options?: UseQueryOptionsWrapper<
Response<AdminStoresRes>,
Response<AdminExtendedStoresRes>,
Error,
ReturnType<StoreQueryKeys["details"]>
>
Expand Down
5 changes: 3 additions & 2 deletions packages/medusa/src/api/routes/admin/store/get-store.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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":
Expand All @@ -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")
}
Expand Down
21 changes: 18 additions & 3 deletions packages/medusa/src/api/routes/admin/store/index.ts
Original file line number Diff line number Diff line change
@@ -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"

Expand Down Expand Up @@ -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
Expand Down