Skip to content

The complete open source platform to run your entire marketplace. Storefront, vendor panel, admin console, and integrations in one enterprise-grade platform you own.

feat(reviews): vendor reviews in the vendor panel (#1308)

Viktor Holik12465f0eb65a
diff --git a/apps/api/src/scripts/seed-reviews-seller-mercur.ts b/apps/api/src/scripts/seed-reviews-seller-mercur.ts
new file mode 100644
index 000000000..8ae89899b
--- /dev/null
+++ b/apps/api/src/scripts/seed-reviews-seller-mercur.ts
@@ -0,0 +1,148 @@
+import { ExecArgs } from "@medusajs/framework/types"
+import { Link } from "@medusajs/framework/modules-sdk"
+import { ContainerRegistrationKeys, Modules } from "@medusajs/framework/utils"
+import { MercurModules } from "@mercurjs/types"
+
+/**
+ * Seed seller reviews for the demo seller behind member `[email protected]`.
+ *
+ * Only seller-reference reviews are seeded: the vendor panel surfaces reviews
+ * through the seller↔review link, so product reviews would never show there.
+ *
+ * Bypasses `createReviewWorkflow` (which requires a real, customer-owned order
+ * and enforces one-review-per-order/reference) and writes directly through the
+ * review service, wiring the customer + seller remote links by hand.
+ *
+ * Run:
+ * bun --cwd apps/api run medusa exec ./src/scripts/seed-reviews-seller-mercur.ts
+ */
+
+const SELLER_MEMBER_EMAIL = "[email protected]"
+
+type ReviewSeed = {
+ rating: number
+ customer_note: string
+ seller_note?: string
+ status?: "pending" | "published" | "rejected"
+}
+
+type CreateReviewInput = {
+ reference: "product" | "seller"
+ rating: number
+ customer_note: string | null
+ seller_note: string | null
+ status: "pending" | "published" | "rejected"
+}
+
+type ReviewModuleService = {
+ createReviews(data: CreateReviewInput): Promise<{ id: string }>
+}
+
+const SELLER_REVIEWS: ReviewSeed[] = [
+ {
+ rating: 5,
+ customer_note: "Fantastic seller — responsive and fast fulfillment.",
+ seller_note: "Appreciate it! Hope to see you again.",
+ status: "published",
+ },
+ {
+ rating: 4,
+ customer_note: "Good communication and packaging. Would buy again.",
+ status: "published",
+ },
+ {
+ rating: 3,
+ customer_note: "Order was fine but replies were a little slow.",
+ status: "pending",
+ },
+ {
+ rating: 5,
+ customer_note: "Best store on the marketplace, hands down.",
+ seller_note: "You just made our day — thank you!",
+ status: "published",
+ },
+ {
+ rating: 2,
+ customer_note: "Item was okay but the follow-up support was lacking.",
+ status: "pending",
+ },
+]
+
+export default async function seedReviewsForMercurSeller({
+ container,
+}: ExecArgs) {
+ const logger = container.resolve(ContainerRegistrationKeys.LOGGER)
+ const query = container.resolve(ContainerRegistrationKeys.QUERY)
+ const link = container.resolve<Link>(ContainerRegistrationKeys.LINK)
+ const reviewService = container.resolve<ReviewModuleService>(
+ MercurModules.REVIEW
+ )
+ const customerModule = container.resolve(Modules.CUSTOMER)
+
+ const { data: sellers } = await query.graph({
+ entity: "seller",
+ fields: ["id", "name"],
+ filters: { members: { email: SELLER_MEMBER_EMAIL } },
+ })
+
+ const seller = sellers[0]
+
+ if (!seller) {
+ logger.error(
+ `No seller found for member email "${SELLER_MEMBER_EMAIL}". Aborting.`
+ )
+ return
+ }
+
+ logger.info(`Seeding reviews for seller "${seller.name}" (${seller.id})`)
+
+ let { data: customers } = await query.graph({
+ entity: "customer",
+ fields: ["id"],
+ pagination: { take: 5, skip: 0 },
+ })
+
+ if (!customers.length) {
+ logger.info("No customers found, creating demo customers...")
+ const created = await customerModule.createCustomers([
+ { email: "[email protected]", first_name: "Ava", last_name: "Nguyen" },
+ { email: "[email protected]", first_name: "Liam", last_name: "Meyer" },
+ { email: "[email protected]", first_name: "Sofia", last_name: "Rossi" },
+ ])
+ customers = created.map((c) => ({ id: c.id }))
+ }
+
+ const pickCustomer = (i: number) => customers[i % customers.length].id
+
+ let created = 0
+
+ for (let i = 0; i < SELLER_REVIEWS.length; i++) {
+ const seed = SELLER_REVIEWS[i]
+
+ const review = await reviewService.createReviews({
+ reference: "seller",
+ rating: seed.rating,
+ customer_note: seed.customer_note,
+ seller_note: seed.seller_note ?? null,
+ status: seed.status ?? "pending",
+ })
+
+ await link.create([
+ {
+ [MercurModules.SELLER]: { seller_id: seller.id },
+ [MercurModules.REVIEW]: { review_id: review.id },
+ },
+ {
+ [Modules.CUSTOMER]: { customer_id: pickCustomer(i) },
+ [MercurModules.REVIEW]: { review_id: review.id },
+ },
+ ])
+
+ created++
+ logger.info(`Seeded seller review (${seed.rating}★) — ${seed.status}`)
+ }
+
+ logger.info(
+ `Done. Created ${created} review(s) for seller "${seller.name}".`
+ )
+}
diff --git a/integration-tests/http/review/vendor/review.spec.ts b/integration-tests/http/review/vendor/review.spec.ts
new file mode 100644
index 000000000..3405f8fa6
--- /dev/null
+++ b/integration-tests/http/review/vendor/review.spec.ts
@@ -0,0 +1,155 @@
+import { medusaIntegrationTestRunner } from "@medusajs/test-utils"
+import { MedusaContainer } from "@medusajs/framework/types"
+import { ContainerRegistrationKeys } from "@medusajs/framework/utils"
+import { MercurModules } from "@mercurjs/types"
+
+import { createSellerUser } from "../../../helpers/create-seller-user"
+
+jest.setTimeout(50000)
+
+const SELLER_MODULE = "seller"
+
+const seedReview = async (
+ container: MedusaContainer,
+ sellerId: string,
+ overrides: Record<string, unknown> = {}
+) => {
+ const service = container.resolve(MercurModules.REVIEW)
+ const link = container.resolve(ContainerRegistrationKeys.LINK)
+
+ const review = await service.createReviews({
+ reference: "seller",
+ rating: 4,
+ customer_note: "Great store",
+ status: "pending",
+ ...overrides,
+ })
+
+ await link.create([
+ {
+ [SELLER_MODULE]: { seller_id: sellerId },
+ [MercurModules.REVIEW]: { review_id: review.id },
+ },
+ ])
+
+ return review
+}
+
+medusaIntegrationTestRunner({
+ testSuite: ({ getContainer, api }) => {
+ describe("Vendor - Reviews", () => {
+ let appContainer: MedusaContainer
+ let sellerHeaders: any
+ let sellerId: string
+
+ beforeAll(() => {
+ appContainer = getContainer()
+ })
+
+ beforeEach(async () => {
+ const result = await createSellerUser(appContainer, {
+ email: "[email protected]",
+ name: "Test Seller",
+ })
+ sellerHeaders = result.headers
+ sellerId = (result.seller as any).id
+ })
+
+ describe("GET /vendor/reviews", () => {
+ it("lists only the authenticated seller's reviews", async () => {
+ await seedReview(appContainer, sellerId)
+
+ const other = await createSellerUser(appContainer, {
+ email: "[email protected]",
+ name: "Other Seller",
+ })
+ await seedReview(appContainer, (other.seller as any).id, {
+ customer_note: "Not mine",
+ })
+
+ const response = await api.get("/vendor/reviews", sellerHeaders)
+
+ expect(response.status).toEqual(200)
+ expect(response.data.count).toEqual(1)
+ expect(response.data.reviews[0].customer_note).toEqual("Great store")
+ expect(response.data.reviews[0].status).toEqual("pending")
+ })
+ })
+
+ describe("GET /vendor/reviews/:id", () => {
+ it("404s for a review that belongs to another seller", async () => {
+ const other = await createSellerUser(appContainer, {
+ email: "[email protected]",
+ name: "Other Seller",
+ })
+ const foreign = await seedReview(
+ appContainer,
+ (other.seller as any).id
+ )
+
+ const response = await api
+ .get(`/vendor/reviews/${foreign.id}`, sellerHeaders)
+ .catch((e) => e.response)
+
+ expect(response.status).toEqual(404)
+ })
+ })
+
+ describe("POST /vendor/reviews/:id (respond)", () => {
+ it("adds a response once and rejects a second response", async () => {
+ const review = await seedReview(appContainer, sellerId)
+
+ const first = await api.post(
+ `/vendor/reviews/${review.id}`,
+ { seller_note: "Thank you for your feedback." },
+ sellerHeaders
+ )
+ expect(first.status).toEqual(200)
+ expect(first.data.review.seller_note).toEqual(
+ "Thank you for your feedback."
+ )
+
+ const second = await api
+ .post(
+ `/vendor/reviews/${review.id}`,
+ { seller_note: "Another response" },
+ sellerHeaders
+ )
+ .catch((e) => e.response)
+
+ expect(second.status).toEqual(400)
+ })
+
+ it("rejects an empty response", async () => {
+ const review = await seedReview(appContainer, sellerId)
+
+ const response = await api
+ .post(
+ `/vendor/reviews/${review.id}`,
+ { seller_note: "" },
+ sellerHeaders
+ )
+ .catch((e) => e.response)
+
+ expect(response.status).toEqual(400)
+ })
+
+ it("does not allow changing status or rating", async () => {
+ const review = await seedReview(appContainer, sellerId)
+
+ await api.post(
+ `/vendor/reviews/${review.id}`,
+ { seller_note: "Thanks", status: "published", rating: 1 },
+ sellerHeaders
+ )
+
+ const service = appContainer.resolve(MercurModules.REVIEW)
+ const [persisted] = await service.listReviews({ id: review.id })
+
+ expect(persisted.status).toEqual("pending")
+ expect(persisted.rating).toEqual(4)
+ })
+ })
+ })
+ },
+})
diff --git a/packages/core/src/api/vendor/middlewares.ts b/packages/core/src/api/vendor/middlewares.ts
index 2e7f47a34..87dcf9fba 100644
--- a/packages/core/src/api/vendor/middlewares.ts
+++ b/packages/core/src/api/vendor/middlewares.ts
@@ -32,6 +32,7 @@ import { vendorRefundReasonsMiddlewares } from "./refund-reasons/middlewares"
import { vendorReservationsMiddlewares } from "./reservations/middlewares"
import { vendorReturnReasonsMiddlewares } from "./return-reasons/middlewares"
import { vendorReturnsMiddlewares } from "./returns/middlewares"
+import { vendorReviewsMiddlewares } from "./reviews/middlewares"
import { vendorSalesChannelsMiddlewares } from "./sales-channels/middlewares"
import { vendorSellersMiddlewares } from "./sellers/middlewares"
import { vendorShippingOptionsMiddlewares } from "./shipping-options/middlewares"
@@ -43,7 +44,6 @@ import { vendorUploadsMiddlewares } from "./uploads/middlewares"
import { ensureSellerMiddleware, scanUnauthenticatedRoutes, unlessBaseUrl, vendorCorsMiddleware } from "../utils"
import { vendorProductAttributesMiddlewares } from "./product-attributes/middlewares"
import { vendorProductTagsMiddlewares } from "./product-tags/middlewares"
-import { vendorReviewsMiddlewares } from "./reviews/middlewares"
const unauthenticatedRoutes = [
/^\/vendor\/sellers$/,
@@ -119,6 +119,7 @@ export const vendorMiddlewares: MiddlewareRoute[] = [
...vendorReservationsMiddlewares,
...vendorReturnReasonsMiddlewares,
...vendorReturnsMiddlewares,
+ ...vendorReviewsMiddlewares,
...vendorSalesChannelsMiddlewares,
...vendorSellersMiddlewares,
...vendorShippingOptionsMiddlewares,
@@ -128,5 +129,4 @@ export const vendorMiddlewares: MiddlewareRoute[] = [
...vendorStoresMiddlewares,
...vendorUploadsMiddlewares,
...vendorProductTagsMiddlewares,
- ...vendorReviewsMiddlewares,
]
diff --git a/packages/core/src/api/vendor/reviews/route.ts b/packages/core/src/api/vendor/reviews/route.ts
index cda8ea342..c95cf0667 100644
--- a/packages/core/src/api/vendor/reviews/route.ts
+++ b/packages/core/src/api/vendor/reviews/route.ts
@@ -2,8 +2,6 @@ import { AuthenticatedMedusaRequest, MedusaResponse } from "@medusajs/framework"
import { ContainerRegistrationKeys } from "@medusajs/framework/utils"
import { VendorReviewListResponse } from "@mercurjs/types"
-import sellerReview from "../../../links/seller-review"
-
export const GET = async (
req: AuthenticatedMedusaRequest,
res: MedusaResponse<VendorReviewListResponse>
@@ -11,14 +9,14 @@ export const GET = async (
const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)
const { data: reviews, metadata } = await query.graph({
- entity: sellerReview.entryPoint,
- fields: req.queryConfig.fields.map((field) => `review.${field}`),
+ entity: "review",
+ fields: req.queryConfig.fields,
filters: req.filterableFields,
pagination: req.queryConfig.pagination,
})
res.json({
- reviews: reviews.map((relation) => relation.review),
+ reviews,
count: metadata?.count ?? 0,
offset: metadata?.skip ?? 0,
limit: metadata?.take ?? 0,
diff --git a/packages/core/src/api/vendor/reviews/validators.ts b/packages/core/src/api/vendor/reviews/validators.ts
index c47b17ea6..b884b109c 100644
--- a/packages/core/src/api/vendor/reviews/validators.ts
+++ b/packages/core/src/api/vendor/reviews/validators.ts
@@ -6,6 +6,14 @@ export const VendorGetReviewsParams = createFindParams({
offset: 0,
limit: 50,
}).extend({
+ q: z.string().optional(),
+ customer_id: z.union([z.string(), z.array(z.string())]).optional(),
+ status: z
+ .union([
+ z.enum(["pending", "published", "rejected"]),
+ z.array(z.enum(["pending", "published", "rejected"])),
+ ])
+ .optional(),
rating: z
.union([
z.coerce.number().int().min(1).max(5),
@@ -17,4 +25,7 @@ export const VendorGetReviewsParams = createFindParams({
export type VendorRespondReviewType = z.infer<typeof VendorRespondReview>
export const VendorRespondReview = z.object({
seller_note: z.string().min(1).max(300),
+ // Accepted but ignored — vendors may not change a review's status or rating.
+ status: z.enum(["pending", "published", "rejected"]).optional(),
+ rating: z.coerce.number().int().min(1).max(5).optional(),
})
diff --git a/packages/core/src/workflows/index.ts b/packages/core/src/workflows/index.ts
index 026817b02..7234b0441 100644
--- a/packages/core/src/workflows/index.ts
+++ b/packages/core/src/workflows/index.ts
@@ -7,6 +7,7 @@ export * from "./order-group"
export * from "./price-list"
export * from "./promotion"
export * from "./promotion-cost"
+export * from "./review"
export * from "./seller"
export * from "./shipping-option"
export * from "./shipping-profile"
diff --git a/packages/dashboard-shared/src/components/common/empty-table-content/empty-table-content.tsx b/packages/dashboard-shared/src/components/common/empty-table-content/empty-table-content.tsx
index 6c824263f..cf8bc4299 100644
--- a/packages/dashboard-shared/src/components/common/empty-table-content/empty-table-content.tsx
+++ b/packages/dashboard-shared/src/components/common/empty-table-content/empty-table-content.tsx
@@ -8,9 +8,15 @@ export type NoResultsProps = {
title?: string
message?: string
className?: string
+ icon?: React.ReactNode
}
-export const NoResults = ({ title, message, className }: NoResultsProps) => {
+export const NoResults = ({
+ title,
+ message,
+ className,
+ icon = <MagnifyingGlass />,
+}: NoResultsProps) => {
const { t } = useTranslation()
return (
@@ -21,7 +27,7 @@ export const NoResults = ({ title, message, className }: NoResultsProps) => {
)}
>
<div className="flex flex-col items-center gap-y-2">
- <MagnifyingGlass />
+ {icon}
<Text size="small" leading="compact" weight="plus">
{title ?? t("general.noResultsTitle")}
</Text>
@@ -40,7 +46,7 @@ type ActionProps = {
}
}
-type NoRecordsProps = {
+export type NoRecordsProps = {
title?: string
message?: string
className?: string
diff --git a/packages/dashboard-shared/src/components/table/data-table/data-table-root/data-table-root.tsx b/packages/dashboard-shared/src/components/table/data-table/data-table-root/data-table-root.tsx
index 18b52a3ad..b72bfc2b6 100644
--- a/packages/dashboard-shared/src/components/table/data-table/data-table-root/data-table-root.tsx
+++ b/packages/dashboard-shared/src/components/table/data-table/data-table-root/data-table-root.tsx
@@ -15,7 +15,7 @@ import {
} from "react"
import { useTranslation } from "react-i18next"
import { Link } from "react-router-dom"
-import { NoResults } from "../../../common/empty-table-content"
+import { NoResults, NoResultsProps } from "../../../common/empty-table-content"
type BulkCommand = {
label: string
@@ -52,6 +52,10 @@ export interface DataTableRootProps<TData> {
* Whether the table is empty due to no results from the active query
*/
noResults?: boolean
+ /**
+ * Props forwarded to the NoResults empty state (title / message / icon)
+ */
+ noResultsProps?: Pick<NoResultsProps, "title" | "message" | "icon">
/**
* Whether to display the tables header
*/
@@ -84,6 +88,7 @@ export const DataTableRoot = <TData,>({
commands,
count = 0,
noResults = false,
+ noResultsProps,
noHeader = false,
layout = "fit",
}: DataTableRootProps<TData>) => {
@@ -310,7 +315,7 @@ export const DataTableRoot = <TData,>({
</Table>
) : (
<div className={clx({ "border-b": layout === "fit" })}>
- <NoResults />
+ <NoResults {...noResultsProps} />
</div>
)}
</div>
diff --git a/packages/dashboard-shared/src/components/table/data-table/data-table.tsx b/packages/dashboard-shared/src/components/table/data-table/data-table.tsx
index 9c741d081..10b23dec2 100644
--- a/packages/dashboard-shared/src/components/table/data-table/data-table.tsx
+++ b/packages/dashboard-shared/src/components/table/data-table/data-table.tsx
@@ -1,17 +1,22 @@
import { clx } from "@medusajs/ui"
import { memo } from "react"
-import { NoRecords, NoResultsProps } from "../../common/empty-table-content"
+import {
+ NoRecords,
+ NoRecordsProps,
+ NoResultsProps,
+} from "../../common/empty-table-content"
import { TableSkeleton } from "../../common/skeleton"
import { DataTableQuery, DataTableQueryProps } from "./data-table-query"
import { DataTableRoot, DataTableRootProps } from "./data-table-root"
interface DataTableProps<TData>
- extends Omit<DataTableRootProps<TData>, "noResults">,
+ extends Omit<DataTableRootProps<TData>, "noResults" | "noResultsProps">,
DataTableQueryProps<TData> {
isLoading?: boolean
pageSize: number
queryObject?: Record<string, any>
- noRecords?: Pick<NoResultsProps, "title" | "message">
+ noRecords?: Pick<NoRecordsProps, "title" | "message" | "icon" | "action">
+ noResults?: Pick<NoResultsProps, "title" | "message" | "icon">
}
// Maybe we should use the memoized version of DataTableRoot
@@ -38,6 +43,7 @@ export const _DataTable = <TData,>({
noHeader = false,
layout = "fit",
noRecords: noRecordsProps = {},
+ noResults: noResultsProps = {},
}: DataTableProps<TData>) => {
if (isLoading) {
return (
@@ -54,7 +60,7 @@ export const _DataTable = <TData,>({
const noQuery =
Object.values(queryObject).filter((v) => Boolean(v)).length === 0
- const noResults = !isLoading && count === 0 && !noQuery
+ const showNoResults = !isLoading && count === 0 && !noQuery
const noRecords = !isLoading && count === 0 && noQuery
if (noRecords) {
@@ -87,7 +93,8 @@ export const _DataTable = <TData,>({
pagination
navigateTo={navigateTo}
commands={commands}
- noResults={noResults}
+ noResults={showNoResults}
+ noResultsProps={noResultsProps}
noHeader={noHeader}
layout={layout}
/>
diff --git a/packages/vendor/src/components/layout/main-layout/main-layout.tsx b/packages/vendor/src/components/layout/main-layout/main-layout.tsx
index 4bdf3e91f..3ee09037d 100644
--- a/packages/vendor/src/components/layout/main-layout/main-layout.tsx
+++ b/packages/vendor/src/components/layout/main-layout/main-layout.tsx
@@ -8,6 +8,7 @@ import {
Plus,
ReceiptPercent,
ShoppingCart,
+ StarSolid,
Tag,
Users,
} from "@medusajs/icons";
@@ -351,6 +352,11 @@ export const useCoreRoutes = (): Omit<INavItem, "pathname">[] => {
label: t("payouts.domain"),
to: "/payouts",
},
+ {
+ icon: <StarSolid />,
+ label: t("reviews.domain"),
+ to: "/reviews",
+ },
];
};
diff --git a/packages/vendor/src/extension-targets.d.ts b/packages/vendor/src/extension-targets.d.ts
index 6cddc7d34..599ebdef0 100644
--- a/packages/vendor/src/extension-targets.d.ts
+++ b/packages/vendor/src/extension-targets.d.ts
@@ -141,6 +141,7 @@ declare module "@mercurjs/dashboard-sdk" {
"price-lists": true
"products": true
"promotions": true
+ "reviews": true
}
interface NavParentRegistry {
@@ -151,6 +152,7 @@ declare module "@mercurjs/dashboard-sdk" {
"price-lists": true
"products": true
"promotions": true
+ "reviews": true
}
interface CustomFieldsRegistry {
diff --git a/packages/vendor/src/get-route-map.tsx b/packages/vendor/src/get-route-map.tsx
index 21fcb2fb7..06707e45d 100644
--- a/packages/vendor/src/get-route-map.tsx
+++ b/packages/vendor/src/get-route-map.tsx
@@ -1031,6 +1031,61 @@ export function getRouteMap({
],
},
+ // REVIEWS
+ {
+ path: "/reviews",
+ errorElement: <ErrorBoundary />,
+ handle: { breadcrumb: () => t("reviews.domain") },
+ children: [
+ {
+ path: "",
+ lazy: async () => {
+ const { ReviewListPage } = await import("./pages/reviews");
+ return {
+ Component: ReviewListPage,
+ };
+ },
+ },
+ {
+ path: ":id",
+ lazy: async () => {
+ const { loader } = await import("./pages/reviews/[id]");
+ const { Breadcrumb } = await import(
+ "./pages/reviews/[id]/breadcrumb"
+ );
+ return {
+ Component: Outlet,
+ loader,
+ handle: {
+ breadcrumb: (match: UIMatch<any>) => (
+ <Breadcrumb {...match} />
+ ),
+ },
+ };
+ },
+ children: [
+ {
+ path: "",
+ lazy: async () => {
+ const { ReviewDetailPage } = await import(
+ "./pages/reviews/[id]"
+ );
+ return {
+ Component: ReviewDetailPage,
+ };
+ },
+ children: [
+ {
+ path: "respond",
+ lazy: () => import("./pages/reviews/[id]/respond"),
+ },
+ ],
+ },
+ ],
+ },
+ ],
+ },
+
// RESERVATIONS - disabled
// {
// path: "/reservations",
diff --git a/packages/vendor/src/hooks/api/reviews.tsx b/packages/vendor/src/hooks/api/reviews.tsx
new file mode 100644
index 000000000..fa117d8e2
--- /dev/null
+++ b/packages/vendor/src/hooks/api/reviews.tsx
@@ -0,0 +1,92 @@
+import {
+ ClientError,
+ InferClientInput,
+ InferClientOutput,
+} from "@mercurjs/client";
+import {
+ UseMutationOptions,
+ UseQueryOptions,
+ useMutation,
+ useQuery,
+} from "@tanstack/react-query";
+
+import { sdk } from "../../lib/client";
+import { queryClient } from "../../lib/query-client";
+import { queryKeysFactory } from "../../lib/query-key-factory";
+
+const REVIEWS_QUERY_KEY = "reviews" as const;
+export const reviewsQueryKeys = queryKeysFactory(REVIEWS_QUERY_KEY);
+
+export type ReviewCustomer = {
+ id: string;
+ first_name: string | null;
+ last_name: string | null;
+ email: string | null;
+};
+
+export type ReviewOrder = {
+ id: string;
+ display_id: number;
+ created_at: string;
+};
+
+export type ReviewDTO = InferClientOutput<
+ typeof sdk.vendor.reviews.$id.query
+>["review"] & {
+ customer?: ReviewCustomer | null;
+ order?: ReviewOrder | null;
+};
+
+export const useReviews = (
+ query?: InferClientInput<typeof sdk.vendor.reviews.query>,
+ options?: UseQueryOptions<
+ unknown,
+ ClientError,
+ InferClientOutput<typeof sdk.vendor.reviews.query>
+ >,
+) => {
+ const { data, ...rest } = useQuery({
+ queryKey: reviewsQueryKeys.list(query),
+ queryFn: async () => sdk.vendor.reviews.query({ ...query }),
+ ...options,
+ });
+
+ return { ...data, ...rest };
+};
+
+export const useReview = (
+ id: string,
+ query?: Omit<InferClientInput<typeof sdk.vendor.reviews.$id.query>, "$id">,
+ options?: UseQueryOptions<
+ unknown,
+ ClientError,
+ InferClientOutput<typeof sdk.vendor.reviews.$id.query>
+ >,
+) => {
+ const { data, ...rest } = useQuery({
+ queryKey: reviewsQueryKeys.detail(id, query),
+ queryFn: async () => sdk.vendor.reviews.$id.query({ $id: id, ...query }),
+ ...options,
+ });
+
+ return { ...data, ...rest };
+};
+
+export const useRespondReview = (
+ id: string,
+ options?: UseMutationOptions<
+ InferClientOutput<typeof sdk.vendor.reviews.$id.mutate>,
+ ClientError,
+ Omit<InferClientInput<typeof sdk.vendor.reviews.$id.mutate>, "$id">
+ >,
+) => {
+ return useMutation({
+ mutationFn: (payload) => sdk.vendor.reviews.$id.mutate({ $id: id, ...payload }),
+ onSuccess: (data, variables, context) => {
+ queryClient.invalidateQueries({ queryKey: reviewsQueryKeys.lists() });
+ queryClient.invalidateQueries({ queryKey: reviewsQueryKeys.detail(id) });
+ options?.onSuccess?.(data, variables, context);
+ },
+ ...options,
+ });
+};
diff --git a/packages/vendor/src/i18n/translations/$schema.json b/packages/vendor/src/i18n/translations/$schema.json
index 6413d0bf1..ae8ea9dbf 100644
--- a/packages/vendor/src/i18n/translations/$schema.json
+++ b/packages/vendor/src/i18n/translations/$schema.json
@@ -5,12 +5,12 @@
"general": {
"type": "object",
"properties": {
- "unknownError": {
- "type": "string"
- },
- "notAvailable": {
- "type": "string"
- },
+ "unknownError": {
+ "type": "string"
+ },
+ "notAvailable": {
+ "type": "string"
+ },
"fullList": {
"type": "string"
},
@@ -448,21 +448,21 @@
"validation": {
"type": "object",
"properties": {
- "requiredField": {
- "type": "string"
- },
- "valueRequired": {
- "type": "string"
- },
- "atLeastOnePrice": {
- "type": "string"
- },
- "currencyCodeNotFound": {
- "type": "string"
- },
- "shippingOptionIdMissing": {
- "type": "string"
- },
+ "requiredField": {
+ "type": "string"
+ },
+ "valueRequired": {
+ "type": "string"
+ },
+ "atLeastOnePrice": {
+ "type": "string"
+ },
+ "currencyCodeNotFound": {
+ "type": "string"
+ },
+ "shippingOptionIdMissing": {
+ "type": "string"
+ },
"rules": {
"type": "object",
"properties": {
@@ -9984,22 +9984,22 @@
"promotions": {
"type": "object",
"properties": {
- "templates": {
- "type": "object",
- "properties": {
- "percentageOffProduct": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "description": {
- "type": "string"
- }
+ "templates": {
+ "type": "object",
+ "properties": {
+ "percentageOffProduct": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
}
}
}
- },
+ }
+ },
"list": {
"type": "object",
"properties": {
@@ -16757,6 +16757,193 @@
},
"$schema": {
"type": "string"
+ },
+ "reviews": {
+ "type": "object",
+ "properties": {
+ "domain": {
+ "type": "string"
+ },
+ "status": {
+ "type": "object",
+ "properties": {
+ "pending": {
+ "type": "string"
+ },
+ "published": {
+ "type": "string"
+ },
+ "rejected": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "pending",
+ "published",
+ "rejected"
+ ],
+ "additionalProperties": false
+ },
+ "fields": {
+ "type": "object",
+ "properties": {
+ "rating": {
+ "type": "string"
+ },
+ "content": {
+ "type": "string"
+ },
+ "response": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "rating",
+ "content",
+ "response"
+ ],
+ "additionalProperties": false
+ },
+ "filters": {
+ "type": "object",
+ "properties": {
+ "stars_one": {
+ "type": "string"
+ },
+ "stars_other": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "stars_one",
+ "stars_other"
+ ],
+ "additionalProperties": false
+ },
+ "list": {
+ "type": "object",
+ "properties": {
+ "columns": {
+ "type": "object",
+ "properties": {
+ "reviewId": {
+ "type": "string"
+ },
+ "rating": {
+ "type": "string"
+ },
+ "content": {
+ "type": "string"
+ },
+ "customer": {
+ "type": "string"
+ },
+ "date": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ },
+ "response": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "reviewId",
+ "rating",
+ "content",
+ "customer",
+ "date",
+ "status",
+ "response"
+ ],
+ "additionalProperties": false
+ },
+ "noRecordsTitle": {
+ "type": "string"
+ },
+ "noRecordsMessage": {
+ "type": "string"
+ },
+ "noResultsTitle": {
+ "type": "string"
+ },
+ "noResultsMessage": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "columns",
+ "noRecordsTitle",
+ "noRecordsMessage",
+ "noResultsTitle",
+ "noResultsMessage"
+ ],
+ "additionalProperties": false
+ },
+ "detail": {
+ "type": "object",
+ "properties": {
+ "customer": {
+ "type": "string"
+ },
+ "order": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "customer",
+ "order"
+ ],
+ "additionalProperties": false
+ },
+ "respond": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string"
+ },
+ "header": {
+ "type": "string"
+ },
+ "label": {
+ "type": "string"
+ },
+ "confirmTitle": {
+ "type": "string"
+ },
+ "confirmDescription": {
+ "type": "string"
+ },
+ "successToast": {
+ "type": "string"
+ },
+ "validation": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "action",
+ "header",
+ "label",
+ "confirmTitle",
+ "confirmDescription",
+ "successToast",
+ "validation"
+ ],
+ "additionalProperties": false
+ }
+ },
+ "required": [
+ "domain",
+ "status",
+ "fields",
+ "filters",
+ "list",
+ "detail",
+ "respond"
+ ],
+ "additionalProperties": false
}
},
"required": [
@@ -16822,7 +17009,8 @@
"dateTime",
"views",
"auth",
- "attributes"
+ "attributes",
+ "reviews"
],
"additionalProperties": false
}
diff --git a/packages/vendor/src/i18n/translations/en.json b/packages/vendor/src/i18n/translations/en.json
index c2776b9ee..83c71b1db 100644
--- a/packages/vendor/src/i18n/translations/en.json
+++ b/packages/vendor/src/i18n/translations/en.json
@@ -2968,6 +2968,51 @@
"canceled": "Canceled"
}
},
+ "reviews": {
+ "domain": "Reviews",
+ "status": {
+ "pending": "Pending",
+ "published": "Published",
+ "rejected": "Rejected"
+ },
+ "fields": {
+ "rating": "Rating",
+ "content": "Content",
+ "response": "Response"
+ },
+ "filters": {
+ "stars_one": "{{count}} star",
+ "stars_other": "{{count}} stars"
+ },
+ "list": {
+ "columns": {
+ "reviewId": "Review ID",
+ "rating": "Rating",
+ "content": "Content",
+ "customer": "Customer",
+ "date": "Date",
+ "status": "Status",
+ "response": "Response"
+ },
+ "noRecordsTitle": "No reviews yet",
+ "noRecordsMessage": "Once customer submit reviews, they'll appear here",
+ "noResultsTitle": "No results",
+ "noResultsMessage": "Try changing the filters or search query"
+ },
+ "detail": {
+ "customer": "Customer",
+ "order": "Order"
+ },
+ "respond": {
+ "action": "Respond",
+ "header": "Respond to review",
+ "label": "Response",
+ "confirmTitle": "Respond to review",
+ "confirmDescription": "Your response will be published on the storefront and visible to customers. Once saved, it cannot be edited or deleted.",
+ "successToast": "Response was successfully sent.",
+ "validation": "Please write a response"
+ }
+ },
"profile": {
"domain": "Profile",
"manageYourProfileDetails": "Manage your profile details.",
diff --git a/packages/vendor/src/pages/index.ts b/packages/vendor/src/pages/index.ts
index 49f783bd2..365df2c08 100644
--- a/packages/vendor/src/pages/index.ts
+++ b/packages/vendor/src/pages/index.ts
@@ -10,4 +10,5 @@ export * from "./payouts"
export * from "./price-lists"
export * from "./products"
export * from "./promotions"
+export * from "./reviews"
export * from "./settings"
diff --git a/packages/vendor/src/pages/reviews/[id]/_components/customer-section.tsx b/packages/vendor/src/pages/reviews/[id]/_components/customer-section.tsx
new file mode 100644
index 000000000..b624a1e26
--- /dev/null
+++ b/packages/vendor/src/pages/reviews/[id]/_components/customer-section.tsx
@@ -0,0 +1,48 @@
+import { User } from "@medusajs/icons";
+import { Container, Heading } from "@medusajs/ui";
+import { ReactNode } from "react";
+import { useTranslation } from "react-i18next";
+
+import { SidebarLink } from "@components/common/sidebar-link/sidebar-link";
+import type { ReviewDTO } from "@hooks/api/reviews";
+
+const SidebarCard = ({
+ title,
+ children,
+}: {
+ title: string;
+ children: ReactNode;
+}) => (
+ <Container className="divide-y p-0">
+ <div className="flex items-center justify-between px-6 py-4">
+ <Heading level="h2">{title}</Heading>
+ </div>
+ {children}
+ </Container>
+);
+
+export const CustomerSection = ({ review }: { review: ReviewDTO }) => {
+ const { t } = useTranslation();
+ const customer = review.customer;
+
+ if (!customer) {
+ return null;
+ }
+
+ const name =
+ [customer.first_name, customer.last_name].filter(Boolean).join(" ") ||
+ customer.email ||
+ customer.id;
+
+ return (
+ <SidebarCard title={t("reviews.detail.customer")}>
+ <SidebarLink
+ to={`/customers/${customer.id}`}
+ labelKey={name}
+ descriptionKey={customer.email ?? ""}
+ icon={<User />}
+ dataTestid="review-customer-link"
+ />
+ </SidebarCard>
+ );
+};
diff --git a/packages/vendor/src/pages/reviews/[id]/_components/order-section.tsx b/packages/vendor/src/pages/reviews/[id]/_components/order-section.tsx
new file mode 100644
index 000000000..24faf5ee9
--- /dev/null
+++ b/packages/vendor/src/pages/reviews/[id]/_components/order-section.tsx
@@ -0,0 +1,53 @@
+import { ShoppingCart } from "@medusajs/icons";
+import { Container, Heading } from "@medusajs/ui";
+import { ReactNode } from "react";
+import { useTranslation } from "react-i18next";
+
+import { SidebarLink } from "@components/common/sidebar-link/sidebar-link";
+import type { ReviewDTO } from "@hooks/api/reviews";
+
+const SidebarCard = ({
+ title,
+ children,
+}: {
+ title: string;
+ children: ReactNode;
+}) => (
+ <Container className="divide-y p-0">
+ <div className="flex items-center justify-between px-6 py-4">
+ <Heading level="h2">{title}</Heading>
+ </div>
+ {children}
+ </Container>
+);
+
+export const OrderSection = ({ review }: { review: ReviewDTO }) => {
+ const { t } = useTranslation();
+ const order = review.order;
+
+ if (!order) {
+ return null;
+ }
+
+ const date = order.created_at
+ ? new Date(order.created_at).toLocaleString(undefined, {
+ year: "numeric",
+ month: "short",
+ day: "numeric",
+ hour: "2-digit",
+ minute: "2-digit",
+ })
+ : undefined;
+
+ return (
+ <SidebarCard title={t("reviews.detail.order")}>
+ <SidebarLink
+ to={`/orders/${order.id}`}
+ labelKey={`#${order.display_id}`}
+ descriptionKey={date ?? ""}
+ icon={<ShoppingCart />}
+ dataTestid="review-order-link"
+ />
+ </SidebarCard>
+ );
+};
diff --git a/packages/vendor/src/pages/reviews/[id]/_components/review-general-section.tsx b/packages/vendor/src/pages/reviews/[id]/_components/review-general-section.tsx
new file mode 100644
index 000000000..b67a38551
--- /dev/null
+++ b/packages/vendor/src/pages/reviews/[id]/_components/review-general-section.tsx
@@ -0,0 +1,76 @@
+import { useTranslation } from "react-i18next";
+import { Link } from "react-router-dom";
+import { Button, Container, Heading, StatusBadge, Text } from "@medusajs/ui";
+
+import type { ReviewDTO } from "@hooks/api/reviews";
+
+import { StarRating, getReviewStatusProps } from "../../common/utils";
+
+const formatDateTime = (value: string | Date) =>
+ new Date(value).toLocaleString(undefined, {
+ year: "numeric",
+ month: "long",
+ day: "numeric",
+ hour: "2-digit",
+ minute: "2-digit",
+ });
+
+export const ReviewGeneralSection = ({ review }: { review: ReviewDTO }) => {
+ const { t } = useTranslation();
+ const { color, label } = getReviewStatusProps(review.status, t);
+ const hasResponse = Boolean(review.seller_note);
+
+ return (
+ <Container className="divide-y p-0">
+ <div className="flex items-center justify-between px-6 py-4">
+ <div>
+ <Heading>#{review.display_id}</Heading>
+ <Text size="small" className="text-ui-fg-subtle">
+ {formatDateTime(review.created_at)}
+ </Text>
+ </div>
+ <div className="flex items-center gap-x-2">
+ <StatusBadge color={color}>{label}</StatusBadge>
+ </div>
+ </div>
+
+ <div className="text-ui-fg-subtle grid grid-cols-2 items-center px-6 py-4">
+ <Text size="small" leading="compact" weight="plus">
+ {t("reviews.fields.rating")}
+ </Text>
+ <StarRating rating={review.rating} />
+ </div>
+
+ <div className="text-ui-fg-subtle grid grid-cols-2 items-start px-6 py-4">
+ <Text size="small" leading="compact" weight="plus">
+ {t("reviews.fields.content")}
+ </Text>
+ <Text size="small" leading="compact">
+ {review.customer_note || "-"}
+ </Text>
+ </div>
+
+ <div className="text-ui-fg-subtle grid grid-cols-2 items-start px-6 py-4">
+ <Text size="small" leading="compact" weight="plus">
+ {t("reviews.fields.response")}
+ </Text>
+ <Text size="small" leading="compact">
+ {review.seller_note || "-"}
+ </Text>
+ </div>
+
+ {!hasResponse && (
+ <div className="flex items-center justify-end px-6 py-4">
+ <Button
+ size="small"
+ variant="secondary"
+ asChild
+ data-testid="review-general-section-respond-button"
+ >
+ <Link to="respond">{t("reviews.respond.action")}</Link>
+ </Button>
+ </div>
+ )}
+ </Container>
+ );
+};
diff --git a/packages/vendor/src/pages/reviews/[id]/breadcrumb.tsx b/packages/vendor/src/pages/reviews/[id]/breadcrumb.tsx
new file mode 100644
index 000000000..9aeff4a1f
--- /dev/null
+++ b/packages/vendor/src/pages/reviews/[id]/breadcrumb.tsx
@@ -0,0 +1,17 @@
+import { UIMatch } from "react-router-dom";
+
+import { useReview } from "@hooks/api/reviews";
+
+export const Breadcrumb = (props: UIMatch) => {
+ const { id } = props.params || {};
+
+ const { review } = useReview(id!, undefined, {
+ enabled: Boolean(id),
+ });
+
+ if (!review) {
+ return null;
+ }
+
+ return <span>#{review.display_id}</span>;
+};
diff --git a/packages/vendor/src/pages/reviews/[id]/index.ts b/packages/vendor/src/pages/reviews/[id]/index.ts
new file mode 100644
index 000000000..15624f54f
--- /dev/null
+++ b/packages/vendor/src/pages/reviews/[id]/index.ts
@@ -0,0 +1,2 @@
+export * from "./loader";
+export * from "./review-detail-page";
diff --git a/packages/vendor/src/pages/reviews/[id]/loader.tsx b/packages/vendor/src/pages/reviews/[id]/loader.tsx
new file mode 100644
index 000000000..fe0761a61
--- /dev/null
+++ b/packages/vendor/src/pages/reviews/[id]/loader.tsx
@@ -0,0 +1,20 @@
+import { LoaderFunctionArgs } from "react-router-dom";
+
+import { reviewsQueryKeys } from "@hooks/api/reviews";
+import { fetchQuery } from "@lib/client";
+import { queryClient } from "@lib/query-client";
+
+const reviewDetailQuery = (id: string) => ({
+ queryKey: reviewsQueryKeys.detail(id),
+ queryFn: async () =>
+ fetchQuery(`/vendor/reviews/${id}`, {
+ method: "GET",
+ }),
+});
+
+export const loader = async ({ params }: LoaderFunctionArgs) => {
+ const id = params.id;
+ const query = reviewDetailQuery(id!);
+
+ return queryClient.ensureQueryData(query);
+};
diff --git a/packages/vendor/src/pages/reviews/[id]/respond/index.tsx b/packages/vendor/src/pages/reviews/[id]/respond/index.tsx
new file mode 100644
index 000000000..100a6db2a
--- /dev/null
+++ b/packages/vendor/src/pages/reviews/[id]/respond/index.tsx
@@ -0,0 +1,42 @@
+// Route: /reviews/:id/respond
+import { Heading } from "@medusajs/ui";
+import { useTranslation } from "react-i18next";
+import { Navigate, useParams } from "react-router-dom";
+
+import { RouteDrawer } from "@components/modals";
+import { VisuallyHidden } from "@components/utilities/visually-hidden";
+import { useReview } from "@hooks/api/reviews";
+
+import { RespondReviewForm } from "./respond-review-form";
+
+export const Component = () => {
+ const { t } = useTranslation();
+ const { id } = useParams();
+
+ const { review, isLoading, isError, error } = useReview(id!);
+
+ if (isError) {
+ throw error;
+ }
+
+ if (!isLoading && review?.seller_note) {
+ return <Navigate to={`/reviews/${id}`} replace />;
+ }
+
+ return (
+ <RouteDrawer>
+ <RouteDrawer.Header>
+ <RouteDrawer.Title asChild>
+ <Heading>{t("reviews.respond.header")}</Heading>
+ </RouteDrawer.Title>
+ <RouteDrawer.Description asChild>
+ <VisuallyHidden>
+ {t("reviews.respond.confirmDescription")}
+ </VisuallyHidden>
+ </RouteDrawer.Description>
+ </RouteDrawer.Header>
+
+ {!isLoading && review && <RespondReviewForm reviewId={review.id} />}
+ </RouteDrawer>
+ );
+};
diff --git a/packages/vendor/src/pages/reviews/[id]/respond/respond-review-form.tsx b/packages/vendor/src/pages/reviews/[id]/respond/respond-review-form.tsx
new file mode 100644
index 000000000..9dc3309fd
--- /dev/null
+++ b/packages/vendor/src/pages/reviews/[id]/respond/respond-review-form.tsx
@@ -0,0 +1,107 @@
+import { useForm } from "react-hook-form";
+import { zodResolver } from "@hookform/resolvers/zod";
+import { Button, Textarea, toast, usePrompt } from "@medusajs/ui";
+import { useTranslation } from "react-i18next";
+import * as zod from "zod";
+
+import { Form } from "@components/common/form";
+import { RouteDrawer, useRouteModal } from "@components/modals";
+import { KeyboundForm } from "@components/utilities/keybound-form";
+import { useRespondReview } from "@hooks/api/reviews";
+
+type RespondReviewFormValues = {
+ seller_note: string;
+};
+
+export const RespondReviewForm = ({ reviewId }: { reviewId: string }) => {
+ const { t } = useTranslation();
+ const { handleSuccess } = useRouteModal();
+ const prompt = usePrompt();
+
+ const form = useForm<RespondReviewFormValues>({
+ resolver: zodResolver(
+ zod.object({
+ seller_note: zod
+ .string()
+ .min(1, t("reviews.respond.validation"))
+ .max(300),
+ }),
+ ),
+ defaultValues: {
+ seller_note: "",
+ },
+ });
+
+ const { mutateAsync, isPending } = useRespondReview(reviewId);
+
+ const handleSubmit = form.handleSubmit(async (data) => {
+ const confirmed = await prompt({
+ title: t("reviews.respond.confirmTitle"),
+ description: t("reviews.respond.confirmDescription"),
+ confirmText: t("actions.save"),
+ cancelText: t("actions.cancel"),
+ variant: "confirmation",
+ });
+
+ if (!confirmed) {
+ return;
+ }
+
+ await mutateAsync(
+ { seller_note: data.seller_note },
+ {
+ onSuccess: () => {
+ toast.success(t("reviews.respond.successToast"));
+ handleSuccess();
+ },
+ onError: (error) => {
+ toast.error(error.message);
+ },
+ },
+ );
+ });
+
+ return (
+ <RouteDrawer.Form form={form}>
+ <KeyboundForm onSubmit={handleSubmit} className="flex flex-1 flex-col">
+ <RouteDrawer.Body>
+ <div className="flex flex-col gap-y-4">
+ <Form.Field
+ control={form.control}
+ name="seller_note"
+ render={({ field }) => (
+ <Form.Item>
+ <Form.Label>{t("reviews.respond.label")}</Form.Label>
+ <Form.Control>
+ <Textarea
+ {...field}
+ data-testid="review-respond-form-textarea"
+ />
+ </Form.Control>
+ <Form.ErrorMessage />
+ </Form.Item>
+ )}
+ />
+ </div>
+ </RouteDrawer.Body>
+ <RouteDrawer.Footer>
+ <div className="flex items-center gap-x-2">
+ <RouteDrawer.Close asChild>
+ <Button size="small" variant="secondary">
+ {t("actions.cancel")}
+ </Button>
+ </RouteDrawer.Close>
+ <Button
+ size="small"
+ type="submit"
+ isLoading={isPending}
+ data-testid="review-respond-form-submit"
+ >
+ {t("actions.save")}
+ </Button>
+ </div>
+ </RouteDrawer.Footer>
+ </KeyboundForm>
+ </RouteDrawer.Form>
+ );
+};
diff --git a/packages/vendor/src/pages/reviews/[id]/review-detail-page.tsx b/packages/vendor/src/pages/reviews/[id]/review-detail-page.tsx
new file mode 100644
index 000000000..740093f8d
--- /dev/null
+++ b/packages/vendor/src/pages/reviews/[id]/review-detail-page.tsx
@@ -0,0 +1,55 @@
+import { Children, ReactNode } from "react";
+import { useLoaderData, useParams } from "react-router-dom";
+
+import { TwoColumnPageSkeleton } from "@components/common/skeleton";
+import { TwoColumnPage } from "@components/layout/pages";
+
+import { useReview } from "@hooks/api/reviews";
+
+import { ReviewGeneralSection } from "./_components/review-general-section";
+import { CustomerSection } from "./_components/customer-section";
+import { OrderSection } from "./_components/order-section";
+
+import type { loader } from "./loader";
+
+const Root = ({ children }: { children?: ReactNode }) => {
+ const initialData = useLoaderData() as Awaited<ReturnType<typeof loader>>;
+ const { id } = useParams();
+ const { review, isLoading, isError, error } = useReview(id!, undefined, {
+ placeholderData: initialData,
+ });
+
+ if (isLoading || !review) {
+ return <TwoColumnPageSkeleton mainSections={1} sidebarSections={2} />;
+ }
+
+ if (isError) {
+ throw error;
+ }
+
+ return (
+ <>
+ {Children.count(children) > 0 ? (
+ children
+ ) : (
+ <TwoColumnPage hasOutlet data={review}>
+ <TwoColumnPage.Main>
+ <ReviewGeneralSection review={review} />
+ </TwoColumnPage.Main>
+ <TwoColumnPage.Sidebar>
+ <CustomerSection review={review} />
+ <OrderSection review={review} />
+ </TwoColumnPage.Sidebar>
+ </TwoColumnPage>
+ )}
+ </>
+ );
+};
+
+export const ReviewDetailPage = Object.assign(Root, {
+ Main: TwoColumnPage.Main,
+ Sidebar: TwoColumnPage.Sidebar,
+ MainGeneralSection: ReviewGeneralSection,
+ SidebarCustomerSection: CustomerSection,
+ SidebarOrderSection: OrderSection,
+});
diff --git a/packages/vendor/src/pages/reviews/_components/review-list-table/index.ts b/packages/vendor/src/pages/reviews/_components/review-list-table/index.ts
new file mode 100644
index 000000000..71198c97a
--- /dev/null
+++ b/packages/vendor/src/pages/reviews/_components/review-list-table/index.ts
@@ -0,0 +1,3 @@
+export { ReviewListTable } from "./review-list-table";
+export { ReviewListHeader } from "./review-list-header";
+export { ReviewListDataTable } from "./review-list-data-table";
diff --git a/packages/vendor/src/pages/reviews/_components/review-list-table/review-list-data-table.tsx b/packages/vendor/src/pages/reviews/_components/review-list-table/review-list-data-table.tsx
new file mode 100644
index 000000000..531b9be42
--- /dev/null
+++ b/packages/vendor/src/pages/reviews/_components/review-list-table/review-list-data-table.tsx
@@ -0,0 +1,70 @@
+import { useTranslation } from "react-i18next";
+import { keepPreviousData } from "@tanstack/react-query";
+import { Star } from "@medusajs/icons";
+
+import { _DataTable, useDataTable } from "@mercurjs/dashboard-shared";
+
+import { useReviews } from "@hooks/api/reviews";
+import { useReviewTableColumns } from "./use-review-table-columns";
+import { useReviewTableQuery } from "./use-review-table-query";
+import { useReviewTableFilters } from "./use-review-table-filters";
+
+const PAGE_SIZE = 20;
+
+export const ReviewListDataTable = () => {
+ const { t } = useTranslation();
+ const { raw, searchParams } = useReviewTableQuery({ pageSize: PAGE_SIZE });
+
+ const { reviews, count, isPending: isLoading, isError, error } = useReviews(
+ searchParams,
+ {
+ placeholderData: keepPreviousData,
+ },
+ );
+
+ const columns = useReviewTableColumns();
+ const filters = useReviewTableFilters();
+
+ const { table } = useDataTable({
+ data: reviews ?? [],
+ columns,
+ count,
+ enablePagination: true,
+ getRowId: (row) => row.id,
+ pageSize: PAGE_SIZE,
+ });
+
+ if (isError) {
+ throw error;
+ }
+
+ return (
+ <_DataTable
+ table={table}
+ columns={columns}
+ count={count}
+ pageSize={PAGE_SIZE}
+ pagination
+ search
+ filters={filters}
+ navigateTo={(row) => `/reviews/${row.original.id}`}
+ isLoading={isLoading}
+ queryObject={raw}
+ orderBy={[
+ { key: "display_id", label: t("reviews.list.columns.reviewId") },
+ { key: "created_at", label: t("fields.createdAt") },
+ { key: "updated_at", label: t("fields.updatedAt") },
+ ]}
+ noRecords={{
+ title: t("reviews.list.noRecordsTitle"),
+ message: t("reviews.list.noRecordsMessage"),
+ icon: <Star className="text-ui-fg-subtle" />,
+ }}
+ noResults={{
+ title: t("reviews.list.noResultsTitle"),
+ message: t("reviews.list.noResultsMessage"),
+ icon: <Star className="text-ui-fg-subtle" />,
+ }}
+ />
+ );
+};
diff --git a/packages/vendor/src/pages/reviews/_components/review-list-table/review-list-header.tsx b/packages/vendor/src/pages/reviews/_components/review-list-table/review-list-header.tsx
new file mode 100644
index 000000000..453b03c99
--- /dev/null
+++ b/packages/vendor/src/pages/reviews/_components/review-list-table/review-list-header.tsx
@@ -0,0 +1,13 @@
+import { useTranslation } from "react-i18next";
+import { Heading } from "@medusajs/ui";
+
+export const ReviewListHeader = () => {
+ const { t } = useTranslation();
+ return (
+ <div className="flex items-center justify-between px-6 py-4">
+ <div>
+ <Heading>{t("reviews.domain")}</Heading>
+ </div>
+ </div>
+ );
+};
diff --git a/packages/vendor/src/pages/reviews/_components/review-list-table/review-list-table.tsx b/packages/vendor/src/pages/reviews/_components/review-list-table/review-list-table.tsx
new file mode 100644
index 000000000..55a09aeb1
--- /dev/null
+++ b/packages/vendor/src/pages/reviews/_components/review-list-table/review-list-table.tsx
@@ -0,0 +1,13 @@
+import { Container } from "@medusajs/ui";
+
+import { ReviewListHeader } from "./review-list-header";
+import { ReviewListDataTable } from "./review-list-data-table";
+
+export const ReviewListTable = () => {
+ return (
+ <Container className="divide-y p-0">
+ <ReviewListHeader />
+ <ReviewListDataTable />
+ </Container>
+ );
+};
diff --git a/packages/vendor/src/pages/reviews/_components/review-list-table/use-review-table-columns.tsx b/packages/vendor/src/pages/reviews/_components/review-list-table/use-review-table-columns.tsx
new file mode 100644
index 000000000..3fa7379ea
--- /dev/null
+++ b/packages/vendor/src/pages/reviews/_components/review-list-table/use-review-table-columns.tsx
@@ -0,0 +1,90 @@
+import { createColumnHelper } from "@tanstack/react-table";
+import { useMemo } from "react";
+import { useTranslation } from "react-i18next";
+import { Text } from "@medusajs/ui";
+import { DateCell } from "@mercurjs/dashboard-shared";
+
+import { StatusCell } from "@components/table/table-cells/common/status-cell";
+import type { ReviewDTO } from "@hooks/api/reviews";
+import { StarRating, getReviewStatusProps } from "../../common/utils";
+
+const columnHelper = createColumnHelper<ReviewDTO>();
+
+const customerName = (customer?: ReviewDTO["customer"]) => {
+ if (!customer) {
+ return "-";
+ }
+ const name = [customer.first_name, customer.last_name]
+ .filter(Boolean)
+ .join(" ");
+ return name || customer.email || "-";
+};
+
+export const useReviewTableColumns = () => {
+ const { t } = useTranslation();
+
+ return useMemo(
+ () => [
+ columnHelper.accessor("display_id", {
+ header: () => <span>{t("reviews.list.columns.reviewId")}</span>,
+ cell: ({ getValue }) => (
+ <Text size="small" leading="compact" className="truncate">
+ #{getValue()}
+ </Text>
+ ),
+ }),
+ columnHelper.accessor("rating", {
+ header: () => <span>{t("reviews.list.columns.rating")}</span>,
+ cell: ({ getValue }) => <StarRating rating={getValue()} />,
+ }),
+ columnHelper.accessor("customer_note", {
+ header: () => <span>{t("reviews.list.columns.content")}</span>,
+ cell: ({ getValue }) => (
+ <div className="w-[240px]">
+ <Text
+ size="small"
+ leading="compact"
+ className="text-ui-fg-subtle line-clamp-3"
+ >
+ {getValue() || "-"}
+ </Text>
+ </div>
+ ),
+ }),
+ columnHelper.accessor("customer", {
+ header: () => <span>{t("reviews.list.columns.customer")}</span>,
+ cell: ({ getValue }) => (
+ <Text size="small" leading="compact" className="truncate">
+ {customerName(getValue())}
+ </Text>
+ ),
+ }),
+ columnHelper.accessor("created_at", {
+ header: () => <span>{t("reviews.list.columns.date")}</span>,
+ cell: ({ getValue }) => <DateCell date={new Date(getValue())} />,
+ }),
+ columnHelper.accessor("status", {
+ header: () => <span>{t("reviews.list.columns.status")}</span>,
+ cell: ({ getValue }) => {
+ const { color, label } = getReviewStatusProps(getValue(), t);
+ return <StatusCell color={color}>{label}</StatusCell>;
+ },
+ }),
+ columnHelper.accessor("seller_note", {
+ header: () => <span>{t("reviews.list.columns.response")}</span>,
+ cell: ({ getValue }) => (
+ <div className="w-[240px]">
+ <Text
+ size="small"
+ leading="compact"
+ className="text-ui-fg-subtle line-clamp-3"
+ >
+ {getValue() || "-"}
+ </Text>
+ </div>
+ ),
+ }),
+ ],
+ [t],
+ );
+};
diff --git a/packages/vendor/src/pages/reviews/_components/review-list-table/use-review-table-filters.tsx b/packages/vendor/src/pages/reviews/_components/review-list-table/use-review-table-filters.tsx
new file mode 100644
index 000000000..0d90fa7aa
--- /dev/null
+++ b/packages/vendor/src/pages/reviews/_components/review-list-table/use-review-table-filters.tsx
@@ -0,0 +1,66 @@
+import { useTranslation } from "react-i18next";
+import { useMemo } from "react";
+
+import type { Filter } from "@mercurjs/dashboard-shared";
+
+import { useCustomers } from "@hooks/api/customers";
+
+const customerLabel = (customer: {
+ first_name?: string | null;
+ last_name?: string | null;
+ email?: string | null;
+}) => {
+ const name = [customer.first_name, customer.last_name]
+ .filter(Boolean)
+ .join(" ");
+ return name || customer.email || "-";
+};
+
+export const useReviewTableFilters = (): Filter[] => {
+ const { t } = useTranslation();
+ const { customers } = useCustomers({ limit: 100 });
+
+ return useMemo(() => {
+ const ratingFilter: Filter = {
+ key: "rating",
+ label: t("reviews.list.columns.rating"),
+ type: "select",
+ multiple: true,
+ options: [5, 4, 3, 2, 1].map((value) => ({
+ label: t("reviews.filters.stars", { count: value }),
+ value: `${value}`,
+ })),
+ };
+
+ const customerFilter: Filter = {
+ key: "customer_id",
+ label: t("reviews.list.columns.customer"),
+ type: "select",
+ multiple: true,
+ options: (customers ?? []).map((customer) => ({
+ label: customerLabel(customer),
+ value: customer.id,
+ })),
+ };
+
+ const createdFilter: Filter = {
+ key: "created_at",
+ label: t("fields.createdAt"),
+ type: "date",
+ };
+
+ const statusFilter: Filter = {
+ key: "status",
+ label: t("reviews.list.columns.status"),
+ type: "select",
+ multiple: true,
+ options: [
+ { label: t("reviews.status.published"), value: "published" },
+ { label: t("reviews.status.pending"), value: "pending" },
+ { label: t("reviews.status.rejected"), value: "rejected" },
+ ],
+ };
+
+ return [ratingFilter, customerFilter, createdFilter, statusFilter];
+ }, [t, customers]);
+};
diff --git a/packages/vendor/src/pages/reviews/_components/review-list-table/use-review-table-query.tsx b/packages/vendor/src/pages/reviews/_components/review-list-table/use-review-table-query.tsx
new file mode 100644
index 000000000..dd5d8ff77
--- /dev/null
+++ b/packages/vendor/src/pages/reviews/_components/review-list-table/use-review-table-query.tsx
@@ -0,0 +1,35 @@
+import { useQueryParams } from "@mercurjs/dashboard-shared";
+
+type UseReviewTableQueryProps = {
+ prefix?: string;
+ pageSize?: number;
+};
+
+export const useReviewTableQuery = ({
+ prefix,
+ pageSize = 20,
+}: UseReviewTableQueryProps) => {
+ const queryObject = useQueryParams(
+ ["offset", "q", "status", "rating", "customer_id", "created_at", "order"],
+ prefix,
+ );
+
+ const { offset, status, rating, customer_id, created_at, q, order } =
+ queryObject;
+
+ const searchParams: Record<string, unknown> = {
+ limit: pageSize,
+ offset: offset ? Number(offset) : 0,
+ status: status ? status.split(",") : undefined,
+ rating: rating ? rating.split(",").map(Number) : undefined,
+ customer_id: customer_id ? customer_id.split(",") : undefined,
+ created_at: created_at ? JSON.parse(created_at) : undefined,
+ order: order ? order : "-display_id",
+ q,
+ };
+
+ return {
+ searchParams,
+ raw: queryObject,
+ };
+};
diff --git a/packages/vendor/src/pages/reviews/common/utils.tsx b/packages/vendor/src/pages/reviews/common/utils.tsx
new file mode 100644
index 000000000..7ccc78c31
--- /dev/null
+++ b/packages/vendor/src/pages/reviews/common/utils.tsx
@@ -0,0 +1,37 @@
+import { StarSolid } from "@medusajs/icons";
+
+import type { ReviewDTO } from "@hooks/api/reviews";
+
+export const getReviewStatusProps = (
+ status: ReviewDTO["status"],
+ t: (key: string) => string,
+) => {
+ switch (status) {
+ case "published":
+ return { color: "green" as const, label: t("reviews.status.published") };
+ case "rejected":
+ return { color: "red" as const, label: t("reviews.status.rejected") };
+ case "pending":
+ default:
+ return { color: "orange" as const, label: t("reviews.status.pending") };
+ }
+};
+
+export const StarRating = ({ rating }: { rating: number }) => {
+ const value = Math.max(0, Math.min(5, Math.round(rating)));
+
+ return (
+ <div className="flex items-center gap-x-0.5" aria-label={`${value} / 5`}>
+ {Array.from({ length: 5 }).map((_, index) =>
+ index < value ? (
+ <StarSolid key={index} className="text-ui-tag-orange-icon" />
+ ) : (
+ <StarSolid
+ key={index}
+ className="text-ui-tag-orange-icon opacity-30"
+ />
+ ),
+ )}
+ </div>
+ );
+};
diff --git a/packages/vendor/src/pages/reviews/index.ts b/packages/vendor/src/pages/reviews/index.ts
new file mode 100644
index 000000000..d7803b3b0
--- /dev/null
+++ b/packages/vendor/src/pages/reviews/index.ts
@@ -0,0 +1 @@
+export { ReviewListPage } from "./review-list-page";
diff --git a/packages/vendor/src/pages/reviews/review-list-page.tsx b/packages/vendor/src/pages/reviews/review-list-page.tsx
new file mode 100644
index 000000000..82bf2006f
--- /dev/null
+++ b/packages/vendor/src/pages/reviews/review-list-page.tsx
@@ -0,0 +1,23 @@
+import { Children, ReactNode } from "react";
+
+import { SingleColumnPage } from "@mercurjs/dashboard-shared";
+
+import {
+ ReviewListTable,
+ ReviewListHeader,
+ ReviewListDataTable,
+} from "./_components/review-list-table";
+
+const Root = ({ children }: { children?: ReactNode }) => {
+ return (
+ <SingleColumnPage hasOutlet>
+ {Children.count(children) > 0 ? children : <ReviewListTable />}
+ </SingleColumnPage>
+ );
+};
+
+export const ReviewListPage = Object.assign(Root, {
+ Table: ReviewListTable,
+ Header: ReviewListHeader,
+ DataTable: ReviewListDataTable,
+});