asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

feat(medusa): add currency to region responses (#5857)

Browse Source 
Resolves https://github.com/medusajs/medusa/issues/5837
This commit is contained in:
Riqwan Thamir
2023-12-14 16:52:54 +01:00
committed by GitHub
parent ff92619d6c
commit 2d79eeeecc
15 changed files with 331 additions and 170 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
packages/medusa/src/api/routes/admin/regions/__tests__/get-region.js
View File

@@ -19,8 +19,9 @@ const defaultFields = [
const defaultRelations = [
"countries",
"payment_providers",
"currency",
"fulfillment_providers",
"payment_providers",
]
describe("GET /admin/regions/:region_id", () => {

7
packages/medusa/src/api/routes/admin/regions/__tests__/list-regions.js
View File

@@ -1,6 +1,6 @@
import { IdMap } from "medusa-test-utils"
import { RegionServiceMock } from "../../../../../services/__mocks__/region"
import { request } from "../../../../../helpers/test-request"
import { RegionServiceMock } from "../../../../../services/__mocks__/region"
const defaultFields = [
"id",
@@ -19,8 +19,9 @@ const defaultFields = [
const defaultRelations = [
"countries",
"payment_providers",
"currency",
"fulfillment_providers",
"payment_providers",
]
describe("GET /admin/regions", () => {
@@ -54,6 +55,7 @@ describe("GET /admin/regions", () => {
relations: defaultRelations,
take: 50,
skip: 0,
order: { created_at: "DESC" },
}
)
})
@@ -89,6 +91,7 @@ describe("GET /admin/regions", () => {
relations: defaultRelations,
take: 20,
skip: 10,
order: { created_at: "DESC" },
}
)
})

11
packages/medusa/src/api/routes/admin/regions/get-region.ts
View File

@@ -1,6 +1,5 @@
import { defaultAdminRegionFields, defaultAdminRegionRelations } from "."
import RegionService from "../../../../services/region"
import { FindParams } from "../../../../types/common"
/**
* @oas [get] /admin/regions/{id}
@@ -57,10 +56,10 @@ import RegionService from "../../../../services/region"
export default async (req, res) => {
const { region_id } = req.params
const regionService: RegionService = req.scope.resolve("regionService")
const region = await regionService.retrieve(region_id, {
select: defaultAdminRegionFields,
relations: defaultAdminRegionRelations,
})
const region = await regionService.retrieve(region_id, req.retrieveConfig)
res.status(200).json({ region })
}
export class AdminGetRegionsRegionParams extends FindParams {}

58
packages/medusa/src/api/routes/admin/regions/index.ts
View File

@@ -1,10 +1,12 @@
import { FlagRouter } from "@medusajs/utils"
import { FlagRouter, wrapHandler } from "@medusajs/utils"
import { Router } from "express"
import "reflect-metadata"
import { Region } from "../../../.."
import TaxInclusivePricingFeatureFlag from "../../../../loaders/feature-flags/tax-inclusive-pricing"
import { DeleteResponse, PaginatedResponse } from "../../../../types/common"
import middlewares from "../../../middlewares"
import { transformQuery } from "../../../middlewares"
import getRegion, { AdminGetRegionsRegionParams } from "./get-region"
import listRegions, { AdminGetRegionsParams } from "./list-regions"
const route = Router()
@@ -15,50 +17,65 @@ export default (app, featureFlagRouter: FlagRouter) => {
defaultAdminRegionFields.push("includes_tax")
}
route.get("/", middlewares.wrap(require("./list-regions").default))
route.get("/:region_id", middlewares.wrap(require("./get-region").default))
const retrieveTransformQueryConfig = {
defaultFields: defaultAdminRegionFields,
defaultRelations: defaultAdminRegionRelations,
allowedRelations: defaultAdminRegionRelations,
isList: false,
}
const listTransformQueryConfig = {
...retrieveTransformQueryConfig,
isList: true,
}
route.get(
"/",
transformQuery(AdminGetRegionsParams, listTransformQueryConfig),
wrapHandler(listRegions)
)
route.get(
"/:region_id",
transformQuery(AdminGetRegionsRegionParams, retrieveTransformQueryConfig),
wrapHandler(getRegion)
)
route.get(
"/:region_id/fulfillment-options",
middlewares.wrap(require("./get-fulfillment-options").default)
wrapHandler(require("./get-fulfillment-options").default)
)
route.post("/", middlewares.wrap(require("./create-region").default))
route.post(
"/:region_id",
middlewares.wrap(require("./update-region").default)
)
route.post("/", wrapHandler(require("./create-region").default))
route.post("/:region_id", wrapHandler(require("./update-region").default))
route.delete(
"/:region_id",
middlewares.wrap(require("./delete-region").default)
)
route.delete("/:region_id", wrapHandler(require("./delete-region").default))
route.post(
"/:region_id/countries",
middlewares.wrap(require("./add-country").default)
wrapHandler(require("./add-country").default)
)
route.delete(
"/:region_id/countries/:country_code",
middlewares.wrap(require("./remove-country").default)
wrapHandler(require("./remove-country").default)
)
route.post(
"/:region_id/payment-providers",
middlewares.wrap(require("./add-payment-provider").default)
wrapHandler(require("./add-payment-provider").default)
)
route.delete(
"/:region_id/payment-providers/:provider_id",
middlewares.wrap(require("./remove-payment-provider").default)
wrapHandler(require("./remove-payment-provider").default)
)
route.post(
"/:region_id/fulfillment-providers",
middlewares.wrap(require("./add-fulfillment-provider").default)
wrapHandler(require("./add-fulfillment-provider").default)
)
route.delete(
"/:region_id/fulfillment-providers/:provider_id",
middlewares.wrap(require("./remove-fulfillment-provider").default)
wrapHandler(require("./remove-fulfillment-provider").default)
)
return app
@@ -83,6 +100,7 @@ export const defaultAdminRegionRelations = [
"countries",
"payment_providers",
"fulfillment_providers",
"currency",
]
/**

62
packages/medusa/src/api/routes/admin/regions/list-regions.ts
View File

@@ -1,12 +1,10 @@
import { IsInt, IsOptional, ValidateNested } from "class-validator"
import _, { identity } from "lodash"
import { defaultAdminRegionFields, defaultAdminRegionRelations } from "."
import { DateComparisonOperator } from "../../../../types/common"
import { Region } from "../../../.."
import RegionService from "../../../../services/region"
import { Type } from "class-transformer"
import { validator } from "../../../../utils/validator"
import { IsOptional, ValidateNested } from "class-validator"
import RegionService from "../../../../services/region"
import {
DateComparisonOperator,
extendedFindParamsMixin,
} from "../../../../types/common"
/**
* @oas [get] /admin/regions
@@ -144,59 +142,29 @@ import { validator } from "../../../../utils/validator"
* $ref: "#/components/responses/500_error"
*/
export default async (req, res) => {
const validated = await validator(AdminGetRegionsParams, req.query)
const regionService: RegionService = req.scope.resolve("regionService")
const filterableFields = _.omit(validated, ["limit", "offset"])
const listConfig = {
select: defaultAdminRegionFields,
relations: defaultAdminRegionRelations,
skip: validated.offset,
take: validated.limit,
}
const { limit, offset } = req.validatedQuery
const [regions, count] = await regionService.listAndCount(
_.pickBy(filterableFields, identity),
listConfig
req.filterableFields,
req.listConfig
)
res.json({
regions,
count,
offset: validated.offset,
limit: validated.limit,
offset,
limit,
})
}
/**
* {@inheritDoc FindPaginationParams}
*/
export class AdminGetRegionsPaginationParams {
/**
* {@inheritDoc FindPaginationParams.limit}
* @defaultValue 50
*/
@IsInt()
@IsOptional()
@Type(() => Number)
limit?: number = 50
/**
* {@inheritDoc FindPaginationParams.offset}
* @defaultValue 0
*/
@IsInt()
@IsOptional()
@Type(() => Number)
offset?: number = 0
}
/**
* Parameters used to filter and configure the pagination of the retrieved regions.
*/
export class AdminGetRegionsParams extends AdminGetRegionsPaginationParams {
export class AdminGetRegionsParams extends extendedFindParamsMixin({
limit: 50,
offset: 0,
}) {
/**
* Date filters to apply on the regions' `created_at` date.
*/

2
packages/medusa/src/api/routes/store/index.js
View File

@@ -48,7 +48,7 @@ export default (app, container, config) => {
orderEditRoutes(route)
cartRoutes(route, container)
shippingOptionRoutes(route)
regionRoutes(route)
regionRoutes(route, featureFlagRouter)
swapRoutes(route)
variantRoutes(route)
returnRoutes(route)

17
packages/medusa/src/api/routes/store/regions/__tests__/get-region.js
View File

@@ -23,8 +23,23 @@ describe("Get region by id", () => {
{
relations: [
"countries",
"payment_providers",
"currency",
"fulfillment_providers",
"payment_providers",
],
select: [
"id",
"name",
"currency_code",
"tax_rate",
"tax_code",
"gift_cards_taxable",
"automatic_taxes",
"tax_provider_id",
"metadata",
"created_at",
"updated_at",
"deleted_at",
],
}
)

20
packages/medusa/src/api/routes/store/regions/__tests__/list-regions.js
View File

@@ -1,6 +1,6 @@
import { IdMap } from "medusa-test-utils"
import { RegionServiceMock } from "../../../../../services/__mocks__/region"
import { request } from "../../../../../helpers/test-request"
import { RegionServiceMock } from "../../../../../services/__mocks__/region"
describe("List regions", () => {
describe("list regions", () => {
@@ -20,11 +20,27 @@ describe("List regions", () => {
{
relations: [
"countries",
"payment_providers",
"currency",
"fulfillment_providers",
"payment_providers",
],
select: [
"id",
"name",
"currency_code",
"tax_rate",
"tax_code",
"gift_cards_taxable",
"automatic_taxes",
"tax_provider_id",
"metadata",
"created_at",
"updated_at",
"deleted_at",
],
skip: 0,
take: 100,
order: { created_at: "DESC" },
}
)
})

9
packages/medusa/src/api/routes/store/regions/get-region.ts
View File

@@ -1,5 +1,5 @@
import RegionService from "../../../../services/region"
import { defaultRelations } from "."
import { FindParams } from "../../../../types/common"
/**
* @oas [get] /store/regions/{id}
@@ -46,12 +46,11 @@ import { defaultRelations } from "."
*/
export default async (req, res) => {
const { region_id } = req.params
const regionService: RegionService = req.scope.resolve("regionService")
const region = await regionService.retrieve(region_id, {
relations: defaultRelations,
})
const region = await regionService.retrieve(region_id, req.retrieveConfig)
res.json({ region })
}
export class StoreGetRegionsRegionParams extends FindParams {}

56
packages/medusa/src/api/routes/store/regions/index.ts
View File

@@ -1,23 +1,67 @@
import { PaginatedResponse } from "@medusajs/types"
import { Region } from "./../../../../"
import { TaxInclusivePricingFeatureFlag, wrapHandler } from "@medusajs/utils"
import { Router } from "express"
import middlewares from "../../../middlewares"
import { transformQuery } from "../../../middlewares"
import { Region } from "./../../../../"
import getRegion from "./get-region"
import listRegions, { StoreGetRegionsParams } from "./list-regions"
const route = Router()
export default (app) => {
export default (app, featureFlagRouter) => {
if (featureFlagRouter.isFeatureEnabled(TaxInclusivePricingFeatureFlag.key)) {
defaultStoreRegionFields.push("includes_tax")
}
const retrieveTransformQueryConfig = {
defaultFields: defaultStoreRegionFields,
defaultRelations: defaultStoreRegionRelations,
allowedRelations: defaultStoreRegionRelations,
isList: false,
}
const listTransformQueryConfig = {
...retrieveTransformQueryConfig,
isList: true,
}
app.use("/regions", route)
route.get("/", middlewares.wrap(require("./list-regions").default))
route.get("/:region_id", middlewares.wrap(require("./get-region").default))
route.get(
"/",
transformQuery(StoreGetRegionsParams, listTransformQueryConfig),
wrapHandler(listRegions)
)
route.get(
"/:region_id",
transformQuery(StoreGetRegionsParams, retrieveTransformQueryConfig),
wrapHandler(getRegion)
)
return app
}
export const defaultRelations = [
export const defaultStoreRegionRelations = [
"countries",
"payment_providers",
"fulfillment_providers",
"currency",
]
export const defaultStoreRegionFields = [
"id",
"name",
"currency_code",
"tax_rate",
"tax_code",
"gift_cards_taxable",
"automatic_taxes",
"tax_provider_id",
"metadata",
"created_at",
"updated_at",
"deleted_at",
]
/**

43
packages/medusa/src/api/routes/store/regions/list-regions.ts
View File

@@ -1,11 +1,11 @@
import { IsInt, IsOptional, ValidateNested } from "class-validator"
import { IsOptional, ValidateNested } from "class-validator"
import { DateComparisonOperator } from "../../../../types/common"
import RegionService from "../../../../services/region"
import { Type } from "class-transformer"
import { defaultRelations } from "."
import { omit } from "lodash"
import { validator } from "../../../../utils/validator"
import RegionService from "../../../../services/region"
import {
DateComparisonOperator,
extendedFindParamsMixin,
} from "../../../../types/common"
/**
* @oas [get] /store/regions
@@ -101,38 +101,21 @@ import { validator } from "../../../../utils/validator"
* $ref: "#/components/responses/500_error"
*/
export default async (req, res) => {
const validated = await validator(StoreGetRegionsParams, req.query)
const { limit, offset } = validated
const regionService: RegionService = req.scope.resolve("regionService")
const filterableFields = omit(validated, ["limit", "offset"])
const listConfig = {
relations: defaultRelations,
skip: offset,
take: limit,
}
const { limit, offset } = req.validatedQuery
const [regions, count] = await regionService.listAndCount(
filterableFields,
listConfig
req.filterableFields,
req.listConfig
)
res.json({ regions, count, limit, offset })
}
export class StoreGetRegionsParams {
@IsOptional()
@IsInt()
@Type(() => Number)
limit?: number = 100
@IsOptional()
@IsInt()
@Type(() => Number)
offset?: number = 0
export class StoreGetRegionsParams extends extendedFindParamsMixin({
limit: 100,
offset: 0,
}) {
@IsOptional()
@ValidateNested()
@Type(() => DateComparisonOperator)