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

feat(customer): list customer (#6206)

Browse Source 
**What**

- GET /admin/customers
- GET /admin/customer-groups
This commit is contained in:
Sebastian Rindom
2024-01-29 16:56:39 +00:00
committed by GitHub
parent 90cff0777f
commit 87390704be
17 changed files with 737 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/medusa/src/api-v2/admin/customer-groups/middlewares.ts
+52
View File
@@ -0,0 +1,52 @@
import { MedusaV2Flag } from "@medusajs/utils"
import {
isFeatureFlagEnabled,
transformBody,
transformQuery,
} from "../../../api/middlewares"
import { MiddlewareRoute } from "../../../loaders/helpers/routing/types"
import * as QueryConfig from "./query-config"
import {
AdminGetCustomerGroupsParams,
AdminGetCustomerGroupsGroupParams,
AdminPostCustomerGroupsReq,
AdminPostCustomerGroupsGroupReq,
} from "./validators"
export const adminCustomerGroupRoutesMiddlewares: MiddlewareRoute[] = [
{
matcher: "/admin/customer-groups*",
middlewares: [isFeatureFlagEnabled(MedusaV2Flag.key)],
},
{
method: ["GET"],
matcher: "/admin/customer-groups",
middlewares: [
transformQuery(
AdminGetCustomerGroupsParams,
QueryConfig.listTransformQueryConfig
),
],
},
{
method: ["GET"],
matcher: "/admin/customer-groups/:id",
middlewares: [
transformQuery(
AdminGetCustomerGroupsGroupParams,
QueryConfig.retrieveTransformQueryConfig
),
],
},
{
method: ["POST"],
matcher: "/admin/customer-groups",
middlewares: [transformBody(AdminPostCustomerGroupsReq)],
},
{
method: ["POST"],
matcher: "/admin/customer-groups/:id",
middlewares: [transformBody(AdminPostCustomerGroupsGroupReq)],
},
]
packages/medusa/src/api-v2/admin/customer-groups/query-config.ts
+21
View File
@@ -0,0 +1,21 @@
export const defaultAdminCustomerGroupRelations = []
export const allowedAdminCustomerGroupRelations = ["customers"]
export const defaultAdminCustomerGroupFields = [
"id",
"name",
"created_at",
"updated_at",
"deleted_at",
]
export const retrieveTransformQueryConfig = {
defaultFields: defaultAdminCustomerGroupFields,
defaultRelations: defaultAdminCustomerGroupRelations,
allowedRelations: allowedAdminCustomerGroupRelations,
isList: false,
}
export const listTransformQueryConfig = {
...retrieveTransformQueryConfig,
isList: true,
}
packages/medusa/src/api-v2/admin/customer-groups/route.ts
+24
View File
@@ -0,0 +1,24 @@
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
import { ICustomerModuleService } from "@medusajs/types"
import { MedusaRequest, MedusaResponse } from "../../../types/routing"
export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
const customerModuleService = req.scope.resolve<ICustomerModuleService>(
ModuleRegistrationName.CUSTOMER
)
const [groups, count] =
await customerModuleService.listAndCountCustomerGroups(
req.filterableFields,
req.listConfig
)
const { offset, limit } = req.validatedQuery
res.json({
count,
groups,
offset,
limit,
})
}
packages/medusa/src/api-v2/admin/customer-groups/validators.ts
+114
View File
@@ -0,0 +1,114 @@
import { OperatorMap } from "@medusajs/types"
import { Type } from "class-transformer"
import {
IsNotEmpty,
IsOptional,
IsString,
ValidateNested,
} from "class-validator"
import { FindParams, extendedFindParamsMixin } from "../../../types/common"
import { OperatorMapValidator } from "../../../types/validators/operator-map"
export class AdminGetCustomerGroupsGroupParams extends FindParams {}
class FilterableCustomerPropsValidator {
@IsOptional()
@IsString({ each: true })
id?: string | string[]
@IsOptional()
@ValidateNested({ each: true })
@Type(() => OperatorMapValidator)
email?: string | string[] | OperatorMap<string>
@IsOptional()
@IsString({ each: true })
default_billing_address_id?: string | string[] | null
@IsOptional()
@IsString({ each: true })
default_shipping_address_id?: string | string[] | null
@IsOptional()
@IsString({ each: true })
company_name?: string | string[] | OperatorMap<string> | null
@IsOptional()
@IsString({ each: true })
first_name?: string | string[] | OperatorMap<string> | null
@IsOptional()
@IsString({ each: true })
last_name?: string | string[] | OperatorMap<string> | null
@IsOptional()
@IsString({ each: true })
created_by?: string | string[] | null
@IsOptional()
@ValidateNested()
@Type(() => OperatorMapValidator)
created_at?: OperatorMap<string>
@IsOptional()
@ValidateNested()
@Type(() => OperatorMapValidator)
updated_at?: OperatorMap<string>
}
export class AdminGetCustomerGroupsParams extends extendedFindParamsMixin({
limit: 100,
offset: 0,
}) {
@IsOptional()
@IsString({ each: true })
id?: string | string[]
@IsOptional()
@ValidateNested({ each: true })
@Type(() => OperatorMapValidator)
name?: string | OperatorMap<string>
@IsOptional()
@ValidateNested()
@Type(() => FilterableCustomerPropsValidator)
customers?: FilterableCustomerPropsValidator | string | string[]
@IsOptional()
@IsString({ each: true })
created_by?: string | string[] | null
@IsOptional()
@ValidateNested()
@Type(() => OperatorMapValidator)
created_at?: OperatorMap<string>
@IsOptional()
@ValidateNested()
@Type(() => OperatorMapValidator)
updated_at?: OperatorMap<string>
// Additional filters from BaseFilterable
@IsOptional()
@ValidateNested({ each: true })
@Type(() => AdminGetCustomerGroupsParams)
$and?: AdminGetCustomerGroupsParams[]
@IsOptional()
@ValidateNested({ each: true })
@Type(() => AdminGetCustomerGroupsParams)
$or?: AdminGetCustomerGroupsParams[]
}
export class AdminPostCustomerGroupsReq {
@IsNotEmpty()
@IsString()
name: string
}
export class AdminPostCustomerGroupsGroupReq {
@IsNotEmpty()
@IsString()
@IsOptional()
name?: string
}
packages/medusa/src/api-v2/admin/customers/middlewares.ts
+46
View File
@@ -0,0 +1,46 @@
import { MedusaV2Flag } from "@medusajs/utils"
import {
isFeatureFlagEnabled,
transformBody,
transformQuery,
} from "../../../api/middlewares"
import { MiddlewareRoute } from "../../../loaders/helpers/routing/types"
import * as QueryConfig from "./query-config"
import {
AdminGetCustomersParams,
AdminGetCustomersCustomerParams,
AdminPostCustomersCustomerReq,
} from "./validators"
export const adminCustomerRoutesMiddlewares: MiddlewareRoute[] = [
{
matcher: "/admin/customers*",
middlewares: [isFeatureFlagEnabled(MedusaV2Flag.key)],
},
{
method: ["GET"],
matcher: "/admin/customers",
middlewares: [
transformQuery(
AdminGetCustomersParams,
QueryConfig.listTransformQueryConfig
),
],
},
{
method: ["GET"],
matcher: "/admin/customers/:id",
middlewares: [
transformQuery(
AdminGetCustomersCustomerParams,
QueryConfig.retrieveTransformQueryConfig
),
],
},
{
method: ["POST"],
matcher: "/admin/customers/:id",
middlewares: [transformBody(AdminPostCustomersCustomerReq)],
},
]
packages/medusa/src/api-v2/admin/customers/query-config.ts
+29
View File
@@ -0,0 +1,29 @@
export const defaultAdminCustomerRelations = []
export const allowedAdminCustomerRelations = [
"groups",
"default_shipping_address",
"default_billing_address",
"addresses",
]
export const defaultAdminCustomerFields = [
"id",
"company_name",
"first_name",
"last_name",
"email",
"created_at",
"updated_at",
"deleted_at",
]
export const retrieveTransformQueryConfig = {
defaultFields: defaultAdminCustomerFields,
defaultRelations: defaultAdminCustomerRelations,
allowedRelations: allowedAdminCustomerRelations,
isList: false,
}
export const listTransformQueryConfig = {
...retrieveTransformQueryConfig,
isList: true,
}
packages/medusa/src/api-v2/admin/customers/route.ts
+41
View File
@@ -0,0 +1,41 @@
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
import { ICustomerModuleService } from "@medusajs/types"
import { MedusaRequest, MedusaResponse } from "../../../types/routing"
export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
const customerModuleService = req.scope.resolve<ICustomerModuleService>(
ModuleRegistrationName.CUSTOMER
)
const [customers, count] = await customerModuleService.listAndCount(
req.filterableFields,
req.listConfig
)
const { offset, limit } = req.validatedQuery
// TODO: Replace with remote query
//const remoteQuery = req.scope.resolve("remoteQuery")
//const variables = {
// filters: req.filterableFields,
// order: req.listConfig.order,
// skip: req.listConfig.skip,
// take: req.listConfig.take,
//}
//const query = remoteQueryObjectFromString({
// entryPoint: "customer",
// variables,
// fields: [...req.listConfig.select!, ...req.listConfig.relations!],
//})
//const results = await remoteQuery(query)
res.json({
count,
customers,
offset,
limit,
})
}
packages/medusa/src/api-v2/admin/customers/validators.ts
+146
View File
@@ -0,0 +1,146 @@
import { OperatorMap } from "@medusajs/types"
import { Transform, Type } from "class-transformer"
import {
IsNotEmpty,
IsOptional,
IsString,
ValidateNested,
} from "class-validator"
import { FindParams, extendedFindParamsMixin } from "../../../types/common"
import { OperatorMapValidator } from "../../../types/validators/operator-map"
import { IsType } from "../../../utils"
export class AdminGetCustomersCustomerParams extends FindParams {}
export class AdminGetCustomersParams extends extendedFindParamsMixin({
limit: 100,
offset: 0,
}) {
@IsOptional()
@IsString({ each: true })
id?: string | string[]
@IsOptional()
@IsType([String, [String], OperatorMapValidator])
email?: string | string[] | OperatorMap<string>
@IsOptional()
@ValidateNested()
@Type(() => FilterableCustomerGroupPropsValidator)
groups?: FilterableCustomerGroupPropsValidator | string | string[]
@IsOptional()
@IsString({ each: true })
default_billing_address_id?: string | string[] | null
@IsOptional()
@IsString({ each: true })
default_shipping_address_id?: string | string[] | null
@IsOptional()
@IsString({ each: true })
company_name?: string | string[] | OperatorMap<string> | null
@IsOptional()
@IsString({ each: true })
first_name?: string | string[] | OperatorMap<string> | null
@IsOptional()
@IsType([String, [String], OperatorMapValidator])
@Transform(({ value }) => (value === "null" ? null : value))
last_name?: string | string[] | OperatorMap<string> | null
@IsOptional()
@IsString({ each: true })
created_by?: string | string[] | null
@IsOptional()
@ValidateNested()
@Type(() => OperatorMapValidator)
created_at?: OperatorMap<string>
@IsOptional()
@ValidateNested()
@Type(() => OperatorMapValidator)
updated_at?: OperatorMap<string>
// Additional filters from BaseFilterable
@IsOptional()
@ValidateNested({ each: true })
@Type(() => AdminGetCustomersParams)
$and?: AdminGetCustomersParams[]
@IsOptional()
@ValidateNested({ each: true })
@Type(() => AdminGetCustomersParams)
$or?: AdminGetCustomersParams[]
}
class FilterableCustomerGroupPropsValidator {
@IsOptional()
@IsString({ each: true })
id?: string | string[]
@IsOptional()
@ValidateNested({ each: true })
@Type(() => OperatorMapValidator)
name?: string | OperatorMap<string>
@IsOptional()
@IsString({ each: true })
created_by?: string | string[] | null
@IsOptional()
@ValidateNested()
@Type(() => OperatorMapValidator)
created_at?: OperatorMap<string>
@IsOptional()
@ValidateNested()
@Type(() => OperatorMapValidator)
updated_at?: OperatorMap<string>
}
export class AdminPostCustomersReq {
@IsNotEmpty()
@IsString()
@IsOptional()
company_name?: string
@IsNotEmpty()
@IsString()
@IsOptional()
first_name?: string
@IsNotEmpty()
@IsString()
@IsOptional()
last_name?: string
@IsNotEmpty()
@IsString()
@IsOptional()
email?: string
}
export class AdminPostCustomersCustomerReq {
@IsNotEmpty()
@IsString()
@IsOptional()
company_name?: string
@IsNotEmpty()
@IsString()
@IsOptional()
first_name?: string
@IsNotEmpty()
@IsString()
@IsOptional()
last_name?: string
@IsNotEmpty()
@IsString()
@IsOptional()
email?: string
}