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): admin reviews panel and core review module (#1309)

Viktor Holik3fb2964d75b0
diff --git a/apps/api/src/scripts/lib/seed-seller-order.ts b/apps/api/src/scripts/lib/seed-seller-order.ts
new file mode 100644
index 000000000..05801492d
--- /dev/null
+++ b/apps/api/src/scripts/lib/seed-seller-order.ts
@@ -0,0 +1,321 @@
+import { MedusaContainer } from "@medusajs/framework/types"
+import {
+ ContainerRegistrationKeys,
+ Modules,
+} from "@medusajs/framework/utils"
+import {
+ addToCartWorkflow,
+ createCartWorkflow,
+ createPaymentCollectionForCartWorkflow,
+ createPaymentSessionsWorkflow,
+} from "@medusajs/medusa/core-flows"
+import {
+ addSellerShippingMethodToCartWorkflow,
+ completeCartWithSplitOrdersWorkflow,
+} from "@mercurjs/core/workflows"
+
+/**
+ * Create one completed order for a seller by driving the same store checkout
+ * flow that `seed-order.ts` uses (guest cart → seller offers → seller shipping
+ * method → payment collection + system session → complete + split). Returns the
+ * orders created inside the resulting OrderGroup.
+ *
+ * The seller's shipping option is auto-discovered when `shippingOptionId` is
+ * omitted, so callers only need a seller id.
+ */
+
+type OfferRow = {
+ id: string
+ seller_id: string
+ variant_id: string
+}
+
+export type SeededOrder = {
+ id: string
+ display_id: number
+}
+
+export async function seedSellerOrder(
+ container: MedusaContainer,
+ opts: { sellerId: string; shippingOptionId?: string; email?: string }
+): Promise<SeededOrder[]> {
+ const logger = container.resolve(ContainerRegistrationKeys.LOGGER)
+ const query = container.resolve(ContainerRegistrationKeys.QUERY)
+ const link = container.resolve(ContainerRegistrationKeys.LINK)
+ const salesChannelModule = container.resolve(Modules.SALES_CHANNEL)
+ const regionModule = container.resolve(Modules.REGION)
+ const fulfillmentModule = container.resolve(Modules.FULFILLMENT)
+ const productModule = container.resolve(Modules.PRODUCT)
+
+ const { sellerId, email = "[email protected]" } = opts
+
+ // 1. resolve a shipping option that belongs to the seller
+ let shippingOptionId = opts.shippingOptionId
+ if (!shippingOptionId) {
+ const { data: sellerOptions } = await query.graph({
+ entity: "shipping_option",
+ fields: ["id", "seller.id"],
+ filters: {},
+ })
+ shippingOptionId = (
+ sellerOptions as Array<{ id: string; seller?: { id: string } | null }>
+ ).find((o) => o.seller?.id === sellerId)?.id
+ if (!shippingOptionId) {
+ throw new Error(`Seller ${sellerId} has no shipping option`)
+ }
+ }
+
+ const { data: shipRows } = await query.graph({
+ entity: "shipping_option",
+ fields: [
+ "id",
+ "seller.id",
+ "service_zone.id",
+ "service_zone.fulfillment_set_id",
+ ],
+ filters: { id: shippingOptionId },
+ })
+ const shippingOption = shipRows[0] as
+ | {
+ id: string
+ seller?: { id: string } | null
+ service_zone?: { id?: string; fulfillment_set_id?: string } | null
+ }
+ | undefined
+ if (!shippingOption) {
+ throw new Error(`Shipping option ${shippingOptionId} not found`)
+ }
+ if (shippingOption.seller?.id !== sellerId) {
+ throw new Error(
+ `Shipping option ${shippingOptionId} does not belong to seller ${sellerId}`
+ )
+ }
+ const shippingOptionFulfillmentSetId =
+ shippingOption.service_zone?.fulfillment_set_id
+ if (!shippingOption.service_zone?.id) {
+ throw new Error(`Shipping option ${shippingOptionId} has no service zone`)
+ }
+
+ // 2. collect the countries the option's service zone can deliver to
+ const [, totalGeoZones] = await fulfillmentModule.listAndCountGeoZones({
+ type: "country",
+ })
+ const optionCountries: string[] = []
+ const PAGE = 50
+ for (let skip = 0; skip < totalGeoZones; skip += PAGE) {
+ const page = await fulfillmentModule.listGeoZones(
+ { type: "country" },
+ { take: PAGE, skip, relations: ["service_zone"] }
+ )
+ if (!page.length) break
+ for (const g of page) {
+ const zoneId =
+ (g as { service_zone_id?: string }).service_zone_id ??
+ (g as { service_zone?: { id?: string } }).service_zone?.id
+ if (zoneId === shippingOption.service_zone.id && g.country_code) {
+ optionCountries.push(g.country_code.toLowerCase())
+ }
+ }
+ }
+ if (!optionCountries.length) {
+ throw new Error(
+ `Shipping option ${shippingOptionId} has no country geo zone to deliver to`
+ )
+ }
+
+ // 3. find (or extend) a region that covers one of those countries
+ const regions = await regionModule.listRegions({}, { relations: ["countries"] })
+ if (!regions.length) {
+ throw new Error("No regions configured — run the base seed first")
+ }
+ const optionCountrySet = new Set(optionCountries)
+ let region: (typeof regions)[number] | undefined
+ let optionCountry: string | undefined
+ for (const r of regions) {
+ const hit = r.countries?.find(
+ (c) => c.iso_2 && optionCountrySet.has(c.iso_2.toLowerCase())
+ )
+ if (hit) {
+ region = r
+ optionCountry = hit.iso_2!.toLowerCase()
+ break
+ }
+ }
+ if (!region || !optionCountry) {
+ const usedCountries = new Set<string>()
+ for (const r of regions) {
+ for (const c of r.countries ?? []) {
+ if (c.iso_2) usedCountries.add(c.iso_2.toLowerCase())
+ }
+ }
+ const candidate = optionCountries.find((c) => !usedCountries.has(c))
+ if (!candidate) {
+ throw new Error(
+ `Every country in shipping option ${shippingOptionId} is already assigned to another region`
+ )
+ }
+ const target = regions[0]
+ const existing = (target.countries ?? [])
+ .map((c) => c.iso_2)
+ .filter((iso): iso is string => Boolean(iso))
+ await regionModule.updateRegions(target.id, {
+ countries: [...existing, candidate],
+ })
+ region = (
+ await regionModule.listRegions(
+ { id: target.id },
+ { relations: ["countries"] }
+ )
+ )[0]
+ optionCountry = candidate
+ }
+
+ // 4. ensure a sales channel reaches the seller's fulfillment set
+ const [defaultSc] = await salesChannelModule.listSalesChannels(
+ { name: "Default Sales Channel" },
+ { take: 1 }
+ )
+ if (!defaultSc) {
+ throw new Error("Default sales channel not found")
+ }
+ const salesChannel: { id: string; name: string } = defaultSc
+
+ if (shippingOptionFulfillmentSetId) {
+ const { data: slRows } = await query.graph({
+ entity: "stock_locations",
+ fields: ["id", "fulfillment_sets.id"],
+ filters: {},
+ })
+ const sellerStockLocationId = (
+ slRows as Array<{
+ id: string
+ fulfillment_sets?: Array<{ id: string }> | null
+ }>
+ ).find((sl) =>
+ (sl.fulfillment_sets ?? []).some(
+ (fs) => fs?.id === shippingOptionFulfillmentSetId
+ )
+ )?.id
+ if (sellerStockLocationId) {
+ try {
+ await link.create({
+ [Modules.SALES_CHANNEL]: { sales_channel_id: salesChannel.id },
+ [Modules.STOCK_LOCATION]: {
+ stock_location_id: sellerStockLocationId,
+ },
+ })
+ } catch (e: unknown) {
+ if (!(e instanceof Error && /already exists/i.test(e.message))) {
+ throw e
+ }
+ }
+ }
+ }
+
+ // 5. seller offers pointing at a published variant
+ const { data: offerRows } = await query.graph({
+ entity: "offer",
+ fields: ["id", "seller_id", "variant_id"],
+ filters: { seller_id: sellerId },
+ })
+ const offers = (offerRows as unknown as OfferRow[]).filter(
+ (o) => typeof o.variant_id === "string" && o.variant_id.length > 0
+ )
+ if (!offers.length) {
+ throw new Error(`Seller ${sellerId} has no offers with a variant`)
+ }
+ const variants = await productModule.listProductVariants(
+ { id: offers.map((o) => o.variant_id) },
+ { relations: ["product"], take: null }
+ )
+ const variantsById = new Map(variants.map((v) => [v.id, v]))
+ const publishedOffers = offers.filter(
+ (o) => variantsById.get(o.variant_id)?.product?.status === "published"
+ )
+ if (!publishedOffers.length) {
+ throw new Error(
+ `Seller ${sellerId} has offers but none point to a published product variant`
+ )
+ }
+
+ // 6. guest cart
+ const address = {
+ first_name: "Seed",
+ last_name: "Buyer",
+ address_1: "123 Seed St",
+ city: "Seed City",
+ country_code: optionCountry,
+ postal_code: "00000",
+ }
+ const { result: cart } = await createCartWorkflow(container).run({
+ input: {
+ email,
+ region_id: region.id,
+ sales_channel_id: salesChannel.id,
+ currency_code: region.currency_code,
+ shipping_address: address,
+ billing_address: address,
+ },
+ })
+
+ // 7. line items (one workflow run — re-running per item re-fires the
+ // payment-collection hook and throws on the already-linked offer)
+ await addToCartWorkflow(container).run({
+ input: {
+ cart_id: cart.id,
+ items: publishedOffers.map(
+ (offer) =>
+ ({
+ variant_id: offer.variant_id,
+ quantity: 1,
+ offer_id: offer.id,
+ metadata: { offer_id: offer.id },
+ }) as never
+ ),
+ },
+ })
+
+ // 8. seller shipping method
+ await addSellerShippingMethodToCartWorkflow(container).run({
+ input: { cart_id: cart.id, options: [{ id: shippingOptionId }] },
+ })
+
+ // 9. payment collection + system session
+ const { result: paymentCollection } =
+ await createPaymentCollectionForCartWorkflow(container).run({
+ input: { cart_id: cart.id },
+ })
+ await createPaymentSessionsWorkflow(container).run({
+ input: {
+ payment_collection_id: paymentCollection.id,
+ provider_id: "pp_system_default",
+ },
+ })
+
+ // 10. complete → split into per-seller orders
+ const { result, errors } = await completeCartWithSplitOrdersWorkflow(
+ container
+ ).run({ input: { cart_id: cart.id }, throwOnError: false })
+ if (errors?.length) {
+ throw errors[0].error
+ }
+ const orderGroupId = result?.order_group_id
+ if (!orderGroupId) {
+ throw new Error("Cart completion did not return an order group id")
+ }
+
+ const { data: orderGroups } = await query.graph({
+ entity: "order_group",
+ fields: ["id", "orders.id", "orders.display_id"],
+ filters: { id: orderGroupId },
+ })
+ const orders: SeededOrder[] = (orderGroups[0]?.orders ?? [])
+ .filter((o) => Boolean(o?.id))
+ .map((o) => ({ id: o!.id, display_id: o!.display_id }))
+ logger.info(
+ `Seeded ${orders.length} order(s) for seller ${sellerId}: ${orders
+ .map((o) => `#${o.display_id}`)
+ .join(", ")}`
+ )
+ return orders
+}
diff --git a/apps/api/src/scripts/seed-reviews.ts b/apps/api/src/scripts/seed-reviews.ts
new file mode 100644
index 000000000..439f2998b
--- /dev/null
+++ b/apps/api/src/scripts/seed-reviews.ts
@@ -0,0 +1,245 @@
+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"
+
+import { seedSellerOrder, SeededOrder } from "./lib/seed-seller-order"
+
+/**
+ * Seed customer reviews for existing products and sellers.
+ *
+ * Bypasses `createReviewWorkflow` on purpose: that workflow requires a real
+ * order that belongs to the reviewing customer and enforces one-review-per
+ * order/reference. For demo data we create reviews directly through the review
+ * service and wire the remote links (customer + product/seller) by hand.
+ *
+ * Run:
+ * bun --cwd apps/api run medusa exec ./src/scripts/seed-reviews.ts
+ */
+
+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 PRODUCT_REVIEWS: ReviewSeed[] = [
+ {
+ rating: 5,
+ customer_note: "Exactly as described, arrived quickly and the quality is great.",
+ seller_note: "Thanks so much for the kind words — enjoy!",
+ status: "published",
+ },
+ {
+ rating: 4,
+ customer_note: "Really happy with it, only wish the sizing ran a touch larger.",
+ status: "published",
+ },
+ {
+ rating: 3,
+ customer_note: "Decent product but shipping took longer than expected.",
+ status: "pending",
+ },
+ {
+ rating: 5,
+ customer_note: "My second purchase from this catalog. Consistently good.",
+ status: "published",
+ },
+ {
+ rating: 2,
+ customer_note: "Not quite what I expected from the photos.",
+ status: "rejected",
+ },
+]
+
+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",
+ },
+]
+
+export default async function seedReviews({ 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)
+
+ let { data: customers } = await query.graph({
+ entity: "customer",
+ fields: ["id"],
+ pagination: { take: 10, 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 { data: products } = await query.graph({
+ entity: "product",
+ fields: ["id", "title"],
+ filters: { status: "published" },
+ pagination: { take: PRODUCT_REVIEWS.length, skip: 0 },
+ })
+
+ const { data: sellers } = await query.graph({
+ entity: "seller",
+ fields: ["id", "name"],
+ pagination: { take: SELLER_REVIEWS.length, skip: 0 },
+ })
+
+ let { data: orders } = await query.graph({
+ entity: "order",
+ fields: ["id"],
+ pagination: { take: 10, skip: 0 },
+ })
+
+ // Reviews must reference the order the customer bought from. When the demo
+ // DB has no orders yet, drive the real store checkout (per seller) so every
+ // review can be linked to a genuine order. `ordersBySeller` lets a seller
+ // review point at an order that actually belongs to that seller.
+ const ordersBySeller = new Map<string, string>()
+
+ if (!orders.length) {
+ logger.info("No orders found, seeding orders per seller via checkout...")
+ const seeded: SeededOrder[] = []
+ for (const seller of sellers) {
+ try {
+ const sellerOrders = await seedSellerOrder(container, {
+ sellerId: seller.id,
+ })
+ if (sellerOrders[0]) {
+ ordersBySeller.set(seller.id, sellerOrders[0].id)
+ }
+ seeded.push(...sellerOrders)
+ } catch (e) {
+ logger.warn(
+ `Skipped order seeding for seller ${seller.id}: ${
+ e instanceof Error ? e.message : e
+ }`
+ )
+ }
+ }
+ orders = seeded.map((o) => ({ id: o.id }))
+ }
+
+ const pickCustomer = (i: number) => customers[i % customers.length].id
+ const pickOrder = (i: number) =>
+ orders.length ? orders[i % orders.length].id : undefined
+
+ let created = 0
+
+ for (let i = 0; i < products.length; i++) {
+ const seed = PRODUCT_REVIEWS[i]
+ const product = products[i]
+
+ const review = await reviewService.createReviews({
+ reference: "product",
+ rating: seed.rating,
+ customer_note: seed.customer_note,
+ seller_note: seed.seller_note ?? null,
+ status: seed.status ?? "pending",
+ })
+
+ const productLinks: Record<string, Record<string, string>>[] = [
+ {
+ [Modules.PRODUCT]: { product_id: product.id },
+ [MercurModules.REVIEW]: { review_id: review.id },
+ },
+ {
+ [Modules.CUSTOMER]: { customer_id: pickCustomer(i) },
+ [MercurModules.REVIEW]: { review_id: review.id },
+ },
+ ]
+
+ const productOrderId = pickOrder(i)
+ if (productOrderId) {
+ productLinks.push({
+ [Modules.ORDER]: { order_id: productOrderId },
+ [MercurModules.REVIEW]: { review_id: review.id },
+ })
+ }
+
+ await link.create(productLinks)
+
+ created++
+ logger.info(`Seeded product review for "${product.title}" (${seed.rating}★)`)
+ }
+
+ for (let i = 0; i < sellers.length; i++) {
+ const seed = SELLER_REVIEWS[i]
+ const seller = sellers[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",
+ })
+
+ const sellerLinks: Record<string, Record<string, string>>[] = [
+ {
+ [MercurModules.SELLER]: { seller_id: seller.id },
+ [MercurModules.REVIEW]: { review_id: review.id },
+ },
+ {
+ [Modules.CUSTOMER]: { customer_id: pickCustomer(i) },
+ [MercurModules.REVIEW]: { review_id: review.id },
+ },
+ ]
+
+ const sellerOrderId = ordersBySeller.get(seller.id) ?? pickOrder(i)
+ if (sellerOrderId) {
+ sellerLinks.push({
+ [Modules.ORDER]: { order_id: sellerOrderId },
+ [MercurModules.REVIEW]: { review_id: review.id },
+ })
+ }
+
+ await link.create(sellerLinks)
+
+ created++
+ logger.info(`Seeded seller review for "${seller.name}" (${seed.rating}★)`)
+ }
+
+ logger.info(`Done. Created ${created} review(s).`)
+}
diff --git a/claude-progress.md b/claude-progress.md
index 0d58166a2..c27cc1bba 100644
--- a/claude-progress.md
+++ b/claude-progress.md
@@ -62,6 +62,26 @@ checkout / CI (fresh worktree has no install).
## Session Log
+### Session: 2026-07-29 -- Admin Reviews (MER-152, SPEC-2)
+
+- **Goal.** Promote reviews from the registry block into `@mercurjs/core` and build the
+ admin reviews UI to match Figma (canvas `40015049:1019815`, BASIC/store reviews).
+- **Backend.** `packages/core/src/modules/review` (model + `status` enum + migration + service);
+ links customer/order/seller/product; `workflows/review` (create/update/respond-add-once/delete
+ + validate); admin/vendor/store API routes + validators + query-config + middlewares (registered
+ in all three aggregators). `MercurModules.REVIEW` + review DTOs added to `@mercurjs/types`.
+- **Admin UI.** `pages/reviews/{review-list,review-detail,review-edit,review-respond,common}` +
+ `hooks/api/reviews.tsx`; route in `get-route-map.tsx`; sidebar entry after Stores; `reviews.*`
+ i18n. List (Review ID/Rating stars/Content/Store/Customer/Date/Status badge/Response + Rating/
+ Status/Date filters), detail (two-column + Customer/Order/Store sidebar cards), Edit drawer
+ (Status+Rating), Respond drawer (add-once), delete-action hook.
+- **Block removed.** `packages/registry/src/reviews/` + `registry.json` entry + built `r/` artifacts.
+- **Verified.** types+core build ✓, admin ESM bundle ✓, `tsc` clean on review files, `oxlint` clean.
+ Added `integration-tests/http/review/admin/review.spec.ts` (runs in CI — worktree can't run it).
+- **Next.** CI integration run; migration apply on live DB; Figma visual parity; vendor-notify rule.
+
+### Session Log (prior)
+
### Session: 2026-07-21 -- Vendor offer-targeted promotions (PR #1268)
- **Goal.** Port the Medusa promotion-create form into the vendor panel and add
diff --git a/integration-tests/http/review/admin/review.spec.ts b/integration-tests/http/review/admin/review.spec.ts
new file mode 100644
index 000000000..14ba98107
--- /dev/null
+++ b/integration-tests/http/review/admin/review.spec.ts
@@ -0,0 +1,174 @@
+import { medusaIntegrationTestRunner } from "@medusajs/test-utils"
+import { MedusaContainer } from "@medusajs/framework/types"
+import { ContainerRegistrationKeys } from "@medusajs/framework/utils"
+import { MercurModules } from "@mercurjs/types"
+
+import { adminHeaders, createAdminUser } from "../../../helpers/create-admin-user"
+import { createSellerUser } from "../../../helpers/create-seller-user"
+
+jest.setTimeout(50000)
+
+const seedSellerReview = async (
+ container: MedusaContainer,
+ sellerId: string,
+ overrides: Record<string, unknown> = {}
+) => {
+ const reviewService = container.resolve(MercurModules.REVIEW)
+ const link = container.resolve(ContainerRegistrationKeys.LINK)
+
+ const review = await reviewService.createReviews({
+ reference: "seller",
+ rating: 3,
+ customer_note: "It was okay",
+ ...overrides,
+ })
+
+ await link.create([
+ {
+ [MercurModules.SELLER]: { seller_id: sellerId },
+ [MercurModules.REVIEW]: { review_id: review.id },
+ },
+ ])
+
+ return review
+}
+
+medusaIntegrationTestRunner({
+ testSuite: ({ getContainer, api, dbConnection }) => {
+ describe("Admin - Reviews", () => {
+ let appContainer: MedusaContainer
+ let seller: any
+
+ beforeAll(async () => {
+ appContainer = getContainer()
+ })
+
+ beforeEach(async () => {
+ await createAdminUser(dbConnection, adminHeaders, appContainer)
+ const result = await createSellerUser(appContainer)
+ seller = result.seller
+ })
+
+ describe("GET /admin/reviews", () => {
+ it("lists reviews with status defaulting to pending", async () => {
+ await seedSellerReview(appContainer, seller.id)
+
+ const response = await api.get("/admin/reviews", adminHeaders)
+
+ expect(response.status).toEqual(200)
+ expect(Array.isArray(response.data.reviews)).toBe(true)
+ expect(response.data.count).toBeGreaterThanOrEqual(1)
+ expect(response.data.reviews[0].status).toEqual("pending")
+ })
+
+ it("filters reviews by rating", async () => {
+ await seedSellerReview(appContainer, seller.id, { rating: 1 })
+ await seedSellerReview(appContainer, seller.id, { rating: 5 })
+
+ const response = await api.get(
+ "/admin/reviews?rating=5",
+ adminHeaders
+ )
+
+ expect(response.status).toEqual(200)
+ expect(response.data.reviews.every((r: any) => r.rating === 5)).toBe(
+ true
+ )
+ })
+
+ it("filters reviews by status", async () => {
+ await seedSellerReview(appContainer, seller.id, {
+ status: "published",
+ })
+ await seedSellerReview(appContainer, seller.id, { status: "pending" })
+
+ const response = await api.get(
+ "/admin/reviews?status=published",
+ adminHeaders
+ )
+
+ expect(response.status).toEqual(200)
+ expect(
+ response.data.reviews.every((r: any) => r.status === "published")
+ ).toBe(true)
+ })
+ })
+
+ describe("POST /admin/reviews/:id", () => {
+ it("updates the status and rating", async () => {
+ const review = await seedSellerReview(appContainer, seller.id)
+
+ const response = await api.post(
+ `/admin/reviews/${review.id}`,
+ { status: "published", rating: 4 },
+ adminHeaders
+ )
+
+ expect(response.status).toEqual(200)
+ expect(response.data.review.status).toEqual("published")
+ expect(response.data.review.rating).toEqual(4)
+ })
+
+ it("rejects a rating outside 1-5", async () => {
+ const review = await seedSellerReview(appContainer, seller.id)
+
+ const error = await api
+ .post(
+ `/admin/reviews/${review.id}`,
+ { rating: 6 },
+ adminHeaders
+ )
+ .catch((e) => e)
+
+ expect(error.response.status).toEqual(400)
+ })
+ })
+
+ describe("POST /admin/reviews/:id/respond", () => {
+ it("adds a response once and rejects a second response", async () => {
+ const review = await seedSellerReview(appContainer, seller.id)
+
+ const first = await api.post(
+ `/admin/reviews/${review.id}/respond`,
+ { seller_note: "Thanks for the feedback" },
+ adminHeaders
+ )
+
+ expect(first.status).toEqual(200)
+ expect(first.data.review.seller_note).toEqual(
+ "Thanks for the feedback"
+ )
+
+ const second = await api
+ .post(
+ `/admin/reviews/${review.id}/respond`,
+ { seller_note: "Another response" },
+ adminHeaders
+ )
+ .catch((e) => e)
+
+ expect(second.response.status).toBeGreaterThanOrEqual(400)
+ })
+ })
+
+ describe("DELETE /admin/reviews/:id", () => {
+ it("deletes a review", async () => {
+ const review = await seedSellerReview(appContainer, seller.id)
+
+ const response = await api.delete(
+ `/admin/reviews/${review.id}`,
+ adminHeaders
+ )
+
+ expect(response.status).toEqual(200)
+ expect(response.data.deleted).toBe(true)
+
+ const list = await api.get("/admin/reviews", adminHeaders)
+ expect(
+ list.data.reviews.find((r: any) => r.id === review.id)
+ ).toBeUndefined()
+ })
+ })
+ })
+ },
+})
diff --git a/packages/admin/src/components/common/empty-table-content/empty-table-content.tsx b/packages/admin/src/components/common/empty-table-content/empty-table-content.tsx
index 431727259..98ae35faa 100644
--- a/packages/admin/src/components/common/empty-table-content/empty-table-content.tsx
+++ b/packages/admin/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>
diff --git a/packages/admin/src/components/layout/main-layout/main-layout.tsx b/packages/admin/src/components/layout/main-layout/main-layout.tsx
index c4c6d955f..4f0ec2e09 100644
--- a/packages/admin/src/components/layout/main-layout/main-layout.tsx
+++ b/packages/admin/src/components/layout/main-layout/main-layout.tsx
@@ -9,6 +9,7 @@ import {
OpenRectArrowOut,
ReceiptPercent,
ShoppingCart,
+ StarSolid,
Tag,
Users,
} from "@medusajs/icons";
@@ -369,6 +370,11 @@ const useCoreRoutes = (): Omit<INavItem, "pathname">[] => {
label: t("stores.domain"),
to: "/stores",
},
+ {
+ icon: <StarSolid />,
+ label: t("reviews.domain"),
+ to: "/reviews",
+ },
{
icon: <CreditCardRefresh />,
label: t("payouts.domain"),
diff --git a/packages/admin/src/components/table/data-table/data-table-root/data-table-root.tsx b/packages/admin/src/components/table/data-table/data-table-root/data-table-root.tsx
index 899c37716..3b0494684 100644
--- a/packages/admin/src/components/table/data-table/data-table-root/data-table-root.tsx
+++ b/packages/admin/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
@@ -57,6 +57,10 @@ export interface DataTableRootProps<TData> {
* Whether the table is empty due to no results from the active query
*/
noResults?: boolean
+ /**
+ * Content overrides (title/message/icon) for the no-results empty state
+ */
+ noResultsProps?: Pick<NoResultsProps, "title" | "message" | "icon">
/**
* Whether to display the tables header
*/
@@ -90,6 +94,7 @@ export const DataTableRoot = <TData,>({
commands,
count = 0,
noResults = false,
+ noResultsProps,
noHeader = false,
layout = "fit",
}: DataTableRootProps<TData>) => {
@@ -319,7 +324,7 @@ export const DataTableRoot = <TData,>({
</Table>
) : (
<div className={clx({ "border-b": layout === "fit" })}>
- <NoResults />
+ <NoResults {...noResultsProps} />
</div>
)}
</div>
diff --git a/packages/admin/src/components/table/data-table/data-table.tsx b/packages/admin/src/components/table/data-table/data-table.tsx
index d9e736eb7..c706d2af2 100644
--- a/packages/admin/src/components/table/data-table/data-table.tsx
+++ b/packages/admin/src/components/table/data-table/data-table.tsx
@@ -1,17 +1,22 @@
import { clx } from "@medusajs/ui"
import { memo } from "react"
-import { NoRecords, NoRecordsProps } 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<NoRecordsProps, "title" | "message" | "icon" | "action">
+ noResults?: Pick<NoResultsProps, "title" | "message" | "icon">
}
// Maybe we should use the memoized version of DataTableRoot
@@ -40,6 +45,7 @@ export const _DataTable = <TData,>({
noHeader = false,
layout = "fit",
noRecords: noRecordsProps = {},
+ noResults: noResultsProps = {},
toolbarActions,
}: DataTableProps<TData>) => {
if (isLoading) {
@@ -57,7 +63,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) {
@@ -93,7 +99,8 @@ export const _DataTable = <TData,>({
navigateTo={navigateTo}
onRowClick={onRowClick}
commands={commands}
- noResults={noResults}
+ noResults={showNoResults}
+ noResultsProps={noResultsProps}
noHeader={noHeader}
layout={layout}
/>
diff --git a/packages/admin/src/extension-targets.d.ts b/packages/admin/src/extension-targets.d.ts
index 187c5a4ca..a8dce84ca 100644
--- a/packages/admin/src/extension-targets.d.ts
+++ b/packages/admin/src/extension-targets.d.ts
@@ -166,6 +166,7 @@ declare module "@mercurjs/dashboard-sdk" {
"products": true
"promotions": true
"reservations": true
+ "reviews": true
"stores": true
}
@@ -177,6 +178,7 @@ declare module "@mercurjs/dashboard-sdk" {
"price-lists": true
"products": true
"promotions": true
+ "reviews": true
"stores": true
}
diff --git a/packages/admin/src/get-route-map.tsx b/packages/admin/src/get-route-map.tsx
index f14b22544..c11fe7b76 100644
--- a/packages/admin/src/get-route-map.tsx
+++ b/packages/admin/src/get-route-map.tsx
@@ -1,4 +1,5 @@
import type { HttpTypes } from "@medusajs/types";
+import type { AdminReviewResponse } from "@mercurjs/types";
import { t } from "i18next";
import { Outlet, type RouteObject, type UIMatch } from "react-router-dom";
@@ -505,6 +506,55 @@ export function getRouteMap({
},
],
},
+ {
+ path: "/reviews",
+ errorElement: <ErrorBoundary />,
+ handle: {
+ breadcrumb: () => t("reviews.domain"),
+ },
+ children: [
+ {
+ path: "",
+ lazy: () => import("./pages/reviews/review-list"),
+ children: [],
+ },
+ {
+ path: ":id",
+ lazy: async () => {
+ const { Breadcrumb, loader } = await import(
+ "./pages/reviews/review-detail"
+ )
+
+ return {
+ Component: Outlet,
+ loader,
+ handle: {
+ breadcrumb: (
+ match: UIMatch<AdminReviewResponse>,
+ ) => <Breadcrumb {...match} />,
+ },
+ }
+ },
+ children: [
+ {
+ path: "",
+ lazy: () => import("./pages/reviews/review-detail"),
+ children: [
+ {
+ path: "edit",
+ lazy: () => import("./pages/reviews/review-edit"),
+ },
+ {
+ path: "respond",
+ lazy: () =>
+ import("./pages/reviews/review-respond"),
+ },
+ ],
+ },
+ ],
+ },
+ ],
+ },
{
path: "/collections",
errorElement: <ErrorBoundary />,
diff --git a/packages/admin/src/hooks/api/reviews.tsx b/packages/admin/src/hooks/api/reviews.tsx
new file mode 100644
index 000000000..e9d1b6297
--- /dev/null
+++ b/packages/admin/src/hooks/api/reviews.tsx
@@ -0,0 +1,147 @@
+import {
+ ClientError,
+ InferClientInput,
+ InferClientOutput,
+} from "@mercurjs/client"
+import {
+ QueryKey,
+ UseMutationOptions,
+ UseQueryOptions,
+ useMutation,
+ useQuery,
+} from "@tanstack/react-query"
+
+import { ReviewDTO } from "@mercurjs/types"
+
+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)
+
+type ReviewCustomer = {
+ id: string
+ first_name: string | null
+ last_name: string | null
+ email: string | null
+}
+
+type ReviewOrder = {
+ id: string
+ display_id: number
+ created_at: string
+}
+
+type ReviewSeller = {
+ id: string
+ name: string
+ email: string | null
+}
+
+export type AdminReview = ReviewDTO & {
+ customer?: ReviewCustomer | null
+ order?: ReviewOrder | null
+ seller?: ReviewSeller | null
+}
+
+export const useReview = (
+ id: string,
+ query?: Omit<InferClientInput<typeof sdk.admin.reviews.$id.query>, "$id">,
+ options?: Omit<
+ UseQueryOptions<
+ InferClientOutput<typeof sdk.admin.reviews.$id.query>,
+ ClientError,
+ InferClientOutput<typeof sdk.admin.reviews.$id.query>,
+ QueryKey
+ >,
+ "queryFn" | "queryKey"
+ >
+) => {
+ const { data, ...rest } = useQuery({
+ queryKey: reviewsQueryKeys.detail(id, query),
+ queryFn: () => sdk.admin.reviews.$id.query({ $id: id, ...query }),
+ ...options,
+ })
+
+ return { ...data, ...rest }
+}
+
+export const useReviews = (
+ query?: InferClientInput<typeof sdk.admin.reviews.query>,
+ options?: Omit<
+ UseQueryOptions<
+ InferClientOutput<typeof sdk.admin.reviews.query>,
+ ClientError,
+ InferClientOutput<typeof sdk.admin.reviews.query>,
+ QueryKey
+ >,
+ "queryFn" | "queryKey"
+ >
+) => {
+ const { data, ...rest } = useQuery({
+ queryFn: () => sdk.admin.reviews.query({ ...query }),
+ queryKey: reviewsQueryKeys.list(query),
+ ...options,
+ })
+
+ return { ...data, ...rest }
+}
+
+export const useUpdateReview = (
+ id: string,
+ options?: UseMutationOptions<
+ InferClientOutput<typeof sdk.admin.reviews.$id.mutate>,
+ ClientError,
+ Omit<InferClientInput<typeof sdk.admin.reviews.$id.mutate>, "$id">
+ >
+) => {
+ return useMutation({
+ mutationFn: (payload) => sdk.admin.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,
+ })
+}
+
+export const useRespondReview = (
+ id: string,
+ options?: UseMutationOptions<
+ InferClientOutput<typeof sdk.admin.reviews.$id.respond.mutate>,
+ ClientError,
+ Omit<InferClientInput<typeof sdk.admin.reviews.$id.respond.mutate>, "$id">
+ >
+) => {
+ return useMutation({
+ mutationFn: (payload) =>
+ sdk.admin.reviews.$id.respond.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,
+ })
+}
+
+export const useDeleteReview = (
+ id: string,
+ options?: UseMutationOptions<
+ InferClientOutput<typeof sdk.admin.reviews.$id.delete>,
+ ClientError,
+ void
+ >
+) => {
+ return useMutation({
+ mutationFn: () => sdk.admin.reviews.$id.delete({ $id: id }),
+ 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/admin/src/i18n/translations/$schema.json b/packages/admin/src/i18n/translations/$schema.json
index 9c9fdc030..fb5ac6f8b 100644
--- a/packages/admin/src/i18n/translations/$schema.json
+++ b/packages/admin/src/i18n/translations/$schema.json
@@ -5,6 +5,218 @@
"$schema": {
"type": "string"
},
+ "reviews": {
+ "type": "object",
+ "properties": {
+ "domain": {
+ "type": "string"
+ },
+ "subtitle": {
+ "type": "string"
+ },
+ "fields": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "rating": {
+ "type": "string"
+ },
+ "content": {
+ "type": "string"
+ },
+ "store": {
+ "type": "string"
+ },
+ "customer": {
+ "type": "string"
+ },
+ "date": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ },
+ "response": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "rating",
+ "content",
+ "store",
+ "customer",
+ "date",
+ "status",
+ "response"
+ ],
+ "additionalProperties": false
+ },
+ "status": {
+ "type": "object",
+ "properties": {
+ "pending": {
+ "type": "string"
+ },
+ "published": {
+ "type": "string"
+ },
+ "rejected": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "pending",
+ "published",
+ "rejected"
+ ],
+ "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": {
+ "noRecordsTitle": {
+ "type": "string"
+ },
+ "noRecordsMessage": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "noRecordsTitle",
+ "noRecordsMessage"
+ ],
+ "additionalProperties": false
+ },
+ "detail": {
+ "type": "object",
+ "properties": {
+ "customer": {
+ "type": "string"
+ },
+ "order": {
+ "type": "string"
+ },
+ "store": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "customer",
+ "order",
+ "store"
+ ],
+ "additionalProperties": false
+ },
+ "edit": {
+ "type": "object",
+ "properties": {
+ "header": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "successToast": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "header",
+ "description",
+ "successToast"
+ ],
+ "additionalProperties": false
+ },
+ "respond": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string"
+ },
+ "header": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "label": {
+ "type": "string"
+ },
+ "successToast": {
+ "type": "string"
+ },
+ "alreadyResponded": {
+ "type": "string"
+ },
+ "validation": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "action",
+ "header",
+ "description",
+ "label",
+ "successToast",
+ "alreadyResponded",
+ "validation"
+ ],
+ "additionalProperties": false
+ },
+ "delete": {
+ "type": "object",
+ "properties": {
+ "confirmTitle": {
+ "type": "string"
+ },
+ "confirmDescription": {
+ "type": "string"
+ },
+ "successToast": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "confirmTitle",
+ "confirmDescription",
+ "successToast"
+ ],
+ "additionalProperties": false
+ }
+ },
+ "required": [
+ "domain",
+ "subtitle",
+ "fields",
+ "status",
+ "filters",
+ "list",
+ "detail",
+ "edit",
+ "respond",
+ "delete"
+ ],
+ "additionalProperties": false
+ },
"general": {
"type": "object",
"properties": {
diff --git a/packages/admin/src/i18n/translations/en.json b/packages/admin/src/i18n/translations/en.json
index 0856cce6a..e508cc821 100644
--- a/packages/admin/src/i18n/translations/en.json
+++ b/packages/admin/src/i18n/translations/en.json
@@ -890,9 +890,6 @@
"titleRequired": "Please enter a title"
},
"editCollection": "Edit Collection",
- "validation": {
- "titleRequired": "Please enter a title"
- },
"handleTooltip": "The handle is used to reference the collection in your storefront. If not specified, the handle will be generated from the collection title.",
"deleteWarning": "You are about to delete the collection {{title}}. This action cannot be undone.",
"removeSingleProductWarning": "You are about to remove the product {{title}} from the collection. This action cannot be undone.",
@@ -3377,6 +3374,57 @@
"categoryInheritance": "Child categories will inherit this attribute."
}
},
+ "reviews": {
+ "domain": "Reviews",
+ "subtitle": "Manage customer reviews of your stores.",
+ "fields": {
+ "id": "Review ID",
+ "rating": "Rating",
+ "content": "Content",
+ "store": "Store",
+ "customer": "Customer",
+ "date": "Date",
+ "status": "Status",
+ "response": "Response"
+ },
+ "status": {
+ "pending": "Pending",
+ "published": "Published",
+ "rejected": "Rejected"
+ },
+ "filters": {
+ "stars_one": "{{count}} star",
+ "stars_other": "{{count}} stars"
+ },
+ "list": {
+ "noRecordsTitle": "No reviews yet",
+ "noRecordsMessage": "Once customer submit reviews, they'll appear here"
+ },
+ "detail": {
+ "customer": "Customer",
+ "order": "Order",
+ "store": "Store"
+ },
+ "edit": {
+ "header": "Edit Review",
+ "description": "Edit the review's status and rating.",
+ "successToast": "Review was successfully updated."
+ },
+ "respond": {
+ "action": "Respond",
+ "header": "Respond to review",
+ "description": "Add a response to this review.",
+ "label": "Response",
+ "successToast": "Response was successfully sent.",
+ "alreadyResponded": "This review already has a response.",
+ "validation": "Please write a response"
+ },
+ "delete": {
+ "confirmTitle": "Delete review",
+ "confirmDescription": "You are about to delete review. This action cannot be undone.",
+ "successToast": "Review was successfully deleted."
+ }
+ },
"returnReasons": {
"domain": "Return Reasons",
"subtitle": "Manage reasons for returned items.",
diff --git a/packages/admin/src/lib/query-key-factory.ts b/packages/admin/src/lib/query-key-factory.ts
index 8510217ea..0c6d55477 100644
--- a/packages/admin/src/lib/query-key-factory.ts
+++ b/packages/admin/src/lib/query-key-factory.ts
@@ -36,18 +36,19 @@ export const queryKeysFactory = <
>(
globalKey: T
) => {
- const queryKeyFactory: TQueryKey<T, TListQueryType, TDetailQueryType> = {
+ type Keys = TQueryKey<T, TListQueryType, TDetailQueryType>
+ const queryKeyFactory: Keys = {
all: [globalKey],
lists: () => [...queryKeyFactory.all, "list"],
list: (query?: TListQueryType) =>
[...queryKeyFactory.lists(), query ? { query } : undefined].filter(
(k) => !!k
- ),
+ ) as unknown as ReturnType<Keys["list"]>,
details: () => [...queryKeyFactory.all, "detail"],
detail: (id: TDetailQueryType, query?: TListQueryType) =>
[...queryKeyFactory.details(), id, query ? { query } : undefined].filter(
(k) => !!k
- ),
+ ) as unknown as ReturnType<Keys["detail"]>,
}
return queryKeyFactory
}
diff --git a/packages/admin/src/pages/index.ts b/packages/admin/src/pages/index.ts
index b61126879..7c4b429a6 100644
--- a/packages/admin/src/pages/index.ts
+++ b/packages/admin/src/pages/index.ts
@@ -22,6 +22,7 @@ export * from "./refund-reasons"
export * from "./regions"
export * from "./reservations"
export * from "./return-reasons"
+export * from "./reviews"
export * from "./sales-channels"
export * from "./stores"
export * from "./shipping-option-types"
diff --git a/packages/admin/src/pages/reviews/common/hooks/use-delete-review-action.tsx b/packages/admin/src/pages/reviews/common/hooks/use-delete-review-action.tsx
new file mode 100644
index 000000000..7b8cb2fa0
--- /dev/null
+++ b/packages/admin/src/pages/reviews/common/hooks/use-delete-review-action.tsx
@@ -0,0 +1,39 @@
+import { toast, usePrompt } from "@medusajs/ui"
+import { useTranslation } from "react-i18next"
+import { useNavigate } from "react-router-dom"
+
+import { useDeleteReview } from "../../../../hooks/api/reviews"
+
+export const useDeleteReviewAction = (id: string, navigateOnSuccess = false) => {
+ const { t } = useTranslation()
+ const prompt = usePrompt()
+ const navigate = useNavigate()
+ const { mutateAsync } = useDeleteReview(id)
+
+ const handleDelete = async () => {
+ const confirm = await prompt({
+ title: t("reviews.delete.confirmTitle"),
+ description: t("reviews.delete.confirmDescription"),
+ confirmText: t("actions.delete"),
+ cancelText: t("actions.cancel"),
+ })
+
+ if (!confirm) {
+ return
+ }
+
+ await mutateAsync(undefined, {
+ onSuccess: () => {
+ toast.success(t("reviews.delete.successToast"))
+ if (navigateOnSuccess) {
+ navigate("/reviews", { replace: true })
+ }
+ },
+ onError: (e) => {
+ toast.error(e.message)
+ },
+ })
+ }
+
+ return handleDelete
+}
diff --git a/packages/admin/src/pages/reviews/common/utils.tsx b/packages/admin/src/pages/reviews/common/utils.tsx
new file mode 100644
index 000000000..68e24bdee
--- /dev/null
+++ b/packages/admin/src/pages/reviews/common/utils.tsx
@@ -0,0 +1,46 @@
+import { StarSolid } from "@medusajs/icons"
+import { clx } from "@medusajs/ui"
+import { ReviewStatus } from "@mercurjs/types"
+
+export const getReviewStatusColor = (
+ status: ReviewStatus
+): "green" | "orange" | "red" | "grey" => {
+ switch (status) {
+ case "published":
+ return "green"
+ case "pending":
+ return "orange"
+ case "rejected":
+ return "red"
+ default:
+ return "grey"
+ }
+}
+
+export const StarRating = ({
+ rating,
+ className,
+}: {
+ rating: number
+ className?: string
+}) => {
+ const value = Math.max(0, Math.min(5, Math.round(rating)))
+
+ return (
+ <div
+ className={clx("flex items-center gap-x-0.5", className)}
+ 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/admin/src/pages/reviews/index.ts b/packages/admin/src/pages/reviews/index.ts
new file mode 100644
index 000000000..7c4816daa
--- /dev/null
+++ b/packages/admin/src/pages/reviews/index.ts
@@ -0,0 +1,2 @@
+export { ReviewListPage } from "./review-list/review-list"
+export { ReviewDetailPage } from "./review-detail/review-detail"
diff --git a/packages/admin/src/pages/reviews/review-detail/breadcrumb.tsx b/packages/admin/src/pages/reviews/review-detail/breadcrumb.tsx
new file mode 100644
index 000000000..cf211ced2
--- /dev/null
+++ b/packages/admin/src/pages/reviews/review-detail/breadcrumb.tsx
@@ -0,0 +1,26 @@
+import { AdminReviewResponse } from "@mercurjs/types"
+import { UIMatch } from "react-router-dom"
+
+import { useReview } from "../../../hooks/api/reviews"
+import { REVIEW_DETAIL_FIELDS } from "./constants"
+
+type ReviewDetailBreadcrumbProps = UIMatch<AdminReviewResponse>
+
+export const ReviewDetailBreadcrumb = (props: ReviewDetailBreadcrumbProps) => {
+ const { id } = props.params || {}
+
+ const { review } = useReview(
+ id!,
+ { fields: REVIEW_DETAIL_FIELDS },
+ {
+ initialData: props.data,
+ enabled: Boolean(id),
+ }
+ )
+
+ if (!review) {
+ return null
+ }
+
+ return <span>#{review.display_id}</span>
+}
diff --git a/packages/admin/src/pages/reviews/review-detail/components/review-general-section.tsx b/packages/admin/src/pages/reviews/review-detail/components/review-general-section.tsx
new file mode 100644
index 000000000..549906dfb
--- /dev/null
+++ b/packages/admin/src/pages/reviews/review-detail/components/review-general-section.tsx
@@ -0,0 +1,101 @@
+import { PencilSquare, Trash } from "@medusajs/icons"
+import { Button, Container, Heading, StatusBadge, Text } from "@medusajs/ui"
+import { useTranslation } from "react-i18next"
+import { Link } from "react-router-dom"
+
+import { ActionMenu } from "../../../../components/common/action-menu"
+import { AdminReview } from "../../../../hooks/api/reviews"
+import { useDeleteReviewAction } from "../../common/hooks/use-delete-review-action"
+import { getReviewStatusColor, StarRating } from "../../common/utils"
+
+const Row = ({ label, children }: { label: string; children: React.ReactNode }) => (
+ <div className="text-ui-fg-subtle grid grid-cols-2 items-start px-6 py-4">
+ <Text size="small" leading="compact" weight="plus">
+ {label}
+ </Text>
+ <div className="text-ui-fg-subtle">{children}</div>
+ </div>
+)
+
+export const ReviewGeneralSection = ({ review }: { review: AdminReview }) => {
+ const { t } = useTranslation()
+ const handleDelete = useDeleteReviewAction(review.id, true)
+
+ const hasResponse = Boolean(review.seller_note)
+
+ const createdAt = new Date(review.created_at).toLocaleString(undefined, {
+ year: "numeric",
+ month: "short",
+ day: "numeric",
+ hour: "2-digit",
+ minute: "2-digit",
+ })
+
+ return (
+ <Container className="divide-y p-0" data-testid="review-general-section">
+ <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">
+ {createdAt}
+ </Text>
+ </div>
+ <div className="flex items-center gap-x-2">
+ <StatusBadge color={getReviewStatusColor(review.status)}>
+ {t(`reviews.status.${review.status}`)}
+ </StatusBadge>
+ <ActionMenu
+ groups={[
+ {
+ actions: [
+ {
+ icon: <PencilSquare />,
+ label: t("actions.edit"),
+ to: "edit",
+ },
+ ],
+ },
+ {
+ actions: [
+ {
+ icon: <Trash />,
+ label: t("actions.delete"),
+ onClick: handleDelete,
+ },
+ ],
+ },
+ ]}
+ data-testid="review-general-section-action-menu"
+ />
+ </div>
+ </div>
+
+ <Row label={t("reviews.fields.rating")}>
+ <StarRating rating={review.rating} />
+ </Row>
+ <Row label={t("reviews.fields.content")}>
+ <Text size="small" leading="compact">
+ {review.customer_note || "-"}
+ </Text>
+ </Row>
+ <Row label={t("reviews.fields.response")}>
+ <Text size="small" leading="compact">
+ {review.seller_note || "-"}
+ </Text>
+ </Row>
+
+ {!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/admin/src/pages/reviews/review-detail/components/review-sidebar-sections.tsx b/packages/admin/src/pages/reviews/review-detail/components/review-sidebar-sections.tsx
new file mode 100644
index 000000000..e04e2a02b
--- /dev/null
+++ b/packages/admin/src/pages/reviews/review-detail/components/review-sidebar-sections.tsx
@@ -0,0 +1,100 @@
+import { BuildingStorefront, ShoppingCart, 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 { AdminReview } 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 ReviewCustomerSection = ({ review }: { review: AdminReview }) => {
+ 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>
+ )
+}
+
+export const ReviewOrderSection = ({ review }: { review: AdminReview }) => {
+ 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>
+ )
+}
+
+export const ReviewStoreSection = ({ review }: { review: AdminReview }) => {
+ const { t } = useTranslation()
+ const seller = review.seller
+
+ if (!seller) {
+ return null
+ }
+
+ return (
+ <SidebarCard title={t("reviews.detail.store")}>
+ <SidebarLink
+ to={`/stores/${seller.id}`}
+ labelKey={seller.name}
+ descriptionKey={seller.email ?? ""}
+ icon={<BuildingStorefront />}
+ dataTestid="review-store-link"
+ />
+ </SidebarCard>
+ )
+}
diff --git a/packages/admin/src/pages/reviews/review-detail/constants.ts b/packages/admin/src/pages/reviews/review-detail/constants.ts
new file mode 100644
index 000000000..3ce2e06b2
--- /dev/null
+++ b/packages/admin/src/pages/reviews/review-detail/constants.ts
@@ -0,0 +1,2 @@
+export const REVIEW_DETAIL_FIELDS =
+ "id,display_id,reference,rating,customer_note,seller_note,status,created_at,updated_at,customer.id,customer.first_name,customer.last_name,customer.email,order.id,order.display_id,order.created_at,seller.id,seller.name,seller.email"
diff --git a/packages/admin/src/pages/reviews/review-detail/index.ts b/packages/admin/src/pages/reviews/review-detail/index.ts
new file mode 100644
index 000000000..ca9aa9df1
--- /dev/null
+++ b/packages/admin/src/pages/reviews/review-detail/index.ts
@@ -0,0 +1,3 @@
+export { ReviewDetailPage as Component } from "./review-detail"
+export { ReviewDetailBreadcrumb as Breadcrumb } from "./breadcrumb"
+export { reviewLoader as loader } from "./loader"
diff --git a/packages/admin/src/pages/reviews/review-detail/loader.ts b/packages/admin/src/pages/reviews/review-detail/loader.ts
new file mode 100644
index 000000000..1a87cf050
--- /dev/null
+++ b/packages/admin/src/pages/reviews/review-detail/loader.ts
@@ -0,0 +1,21 @@
+import { LoaderFunctionArgs } from "react-router-dom"
+
+import { reviewsQueryKeys } from "../../../hooks/api/reviews"
+import { sdk } from "../../../lib/client"
+import { queryClient } from "../../../lib/query-client"
+import { REVIEW_DETAIL_FIELDS } from "./constants"
+
+const reviewDetailQuery = (id: string) => {
+ const query = { fields: REVIEW_DETAIL_FIELDS }
+ return {
+ queryKey: reviewsQueryKeys.detail(id, query),
+ queryFn: async () => sdk.admin.reviews.$id.query({ $id: id, ...query }),
+ }
+}
+
+export const reviewLoader = async ({ params }: LoaderFunctionArgs) => {
+ const id = params.id
+ const query = reviewDetailQuery(id!)
+
+ return queryClient.ensureQueryData(query)
+}
diff --git a/packages/admin/src/pages/reviews/review-detail/review-detail.tsx b/packages/admin/src/pages/reviews/review-detail/review-detail.tsx
new file mode 100644
index 000000000..cba7437ce
--- /dev/null
+++ b/packages/admin/src/pages/reviews/review-detail/review-detail.tsx
@@ -0,0 +1,57 @@
+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 { REVIEW_DETAIL_FIELDS } from "./constants"
+import { reviewLoader } from "./loader"
+import { ReviewGeneralSection } from "./components/review-general-section"
+import {
+ ReviewCustomerSection,
+ ReviewOrderSection,
+ ReviewStoreSection,
+} from "./components/review-sidebar-sections"
+
+const Root = ({ children }: { children?: ReactNode }) => {
+ const initialData = useLoaderData() as Awaited<ReturnType<typeof reviewLoader>>
+
+ const { id } = useParams()
+ const { review, isLoading, isError, error } = useReview(
+ id!,
+ { fields: REVIEW_DETAIL_FIELDS },
+ { initialData }
+ )
+
+ if (isLoading || !review) {
+ return <TwoColumnPageSkeleton mainSections={1} sidebarSections={3} />
+ }
+
+ if (isError) {
+ throw error
+ }
+
+ return (
+ <TwoColumnPage hasOutlet data={review} data-testid="review-detail-page">
+ <TwoColumnPage.Main>
+ {Children.count(children) > 0 ? (
+ children
+ ) : (
+ <ReviewGeneralSection review={review} />
+ )}
+ </TwoColumnPage.Main>
+ <TwoColumnPage.Sidebar>
+ <ReviewCustomerSection review={review} />
+ <ReviewOrderSection review={review} />
+ <ReviewStoreSection review={review} />
+ </TwoColumnPage.Sidebar>
+ </TwoColumnPage>
+ )
+}
+
+export const ReviewDetailPage = Object.assign(Root, {
+ General: ReviewGeneralSection,
+ Customer: ReviewCustomerSection,
+ Order: ReviewOrderSection,
+ Store: ReviewStoreSection,
+})
diff --git a/packages/admin/src/pages/reviews/review-edit/components/edit-review-form/edit-review-form.tsx b/packages/admin/src/pages/reviews/review-edit/components/edit-review-form/edit-review-form.tsx
new file mode 100644
index 000000000..5a8d516ef
--- /dev/null
+++ b/packages/admin/src/pages/reviews/review-edit/components/edit-review-form/edit-review-form.tsx
@@ -0,0 +1,171 @@
+import { Button, Select, Textarea, toast } from "@medusajs/ui"
+import { useForm } from "react-hook-form"
+import { useTranslation } from "react-i18next"
+import { zodResolver } from "@hookform/resolvers/zod"
+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 { useDocumentDirection } from "../../../../../hooks/use-document-direction"
+import { AdminReview, useUpdateReview } from "../../../../../hooks/api/reviews"
+
+const STATUSES = ["pending", "published", "rejected"] as const
+const RATINGS = [1, 2, 3, 4, 5] as const
+
+const EditReviewSchema = zod.object({
+ status: zod.enum(STATUSES),
+ rating: zod.coerce.number().int().min(1).max(5),
+ customer_note: zod.string().max(1000).optional(),
+})
+
+export const EditReviewForm = ({ review }: { review: AdminReview }) => {
+ const { t } = useTranslation()
+ const { handleSuccess } = useRouteModal()
+ const direction = useDocumentDirection()
+
+ const form = useForm<zod.infer<typeof EditReviewSchema>>({
+ defaultValues: {
+ status: review.status,
+ rating: review.rating,
+ customer_note: review.customer_note ?? "",
+ },
+ resolver: zodResolver(EditReviewSchema),
+ })
+
+ const { mutateAsync, isPending } = useUpdateReview(review.id)
+
+ const handleSubmit = form.handleSubmit(async (data) => {
+ await mutateAsync(
+ {
+ status: data.status,
+ rating: data.rating,
+ customer_note: data.customer_note,
+ },
+ {
+ onSuccess: () => {
+ toast.success(t("reviews.edit.successToast"))
+ handleSuccess()
+ },
+ onError: (error) => {
+ toast.error(error.message)
+ },
+ }
+ )
+ })
+
+ return (
+ <RouteDrawer.Form form={form} data-testid="review-edit-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="status"
+ render={({ field: { ref, onChange, ...field } }) => (
+ <Form.Item>
+ <Form.Label>{t("reviews.fields.status")}</Form.Label>
+ <Form.Control>
+ <Select
+ {...field}
+ onValueChange={onChange}
+ dir={direction}
+ >
+ <Select.Trigger
+ ref={ref}
+ data-testid="review-edit-form-status-input"
+ >
+ <Select.Value />
+ </Select.Trigger>
+ <Select.Content>
+ {STATUSES.map((status) => (
+ <Select.Item key={status} value={status}>
+ {t(`reviews.status.${status}`)}
+ </Select.Item>
+ ))}
+ </Select.Content>
+ </Select>
+ </Form.Control>
+ <Form.ErrorMessage />
+ </Form.Item>
+ )}
+ />
+
+ <Form.Field
+ control={form.control}
+ name="rating"
+ render={({ field: { ref, onChange, value, ...field } }) => (
+ <Form.Item>
+ <Form.Label>{t("reviews.fields.rating")}</Form.Label>
+ <Form.Control>
+ <Select
+ {...field}
+ value={value ? String(value) : undefined}
+ onValueChange={(val) => onChange(Number(val))}
+ dir={direction}
+ >
+ <Select.Trigger
+ ref={ref}
+ data-testid="review-edit-form-rating-input"
+ >
+ <Select.Value />
+ </Select.Trigger>
+ <Select.Content>
+ {RATINGS.map((rating) => (
+ <Select.Item key={rating} value={String(rating)}>
+ {t("reviews.filters.stars", { count: rating })}
+ </Select.Item>
+ ))}
+ </Select.Content>
+ </Select>
+ </Form.Control>
+ <Form.ErrorMessage />
+ </Form.Item>
+ )}
+ />
+
+ <Form.Field
+ control={form.control}
+ name="customer_note"
+ render={({ field }) => (
+ <Form.Item>
+ <Form.Label>{t("reviews.fields.content")}</Form.Label>
+ <Form.Control>
+ <Textarea
+ {...field}
+ data-testid="review-edit-form-content-input"
+ />
+ </Form.Control>
+ <Form.ErrorMessage />
+ </Form.Item>
+ )}
+ />
+ </div>
+ </RouteDrawer.Body>
+
+ <RouteDrawer.Footer>
+ <div className="flex items-center justify-end gap-x-2">
+ <RouteDrawer.Close asChild>
+ <Button
+ variant="secondary"
+ size="small"
+ data-testid="review-edit-form-cancel-button"
+ >
+ {t("actions.cancel")}
+ </Button>
+ </RouteDrawer.Close>
+ <Button
+ isLoading={isPending}
+ type="submit"
+ variant="primary"
+ size="small"
+ data-testid="review-edit-form-save-button"
+ >
+ {t("actions.save")}
+ </Button>
+ </div>
+ </RouteDrawer.Footer>
+ </KeyboundForm>
+ </RouteDrawer.Form>
+ )
+}
diff --git a/packages/admin/src/pages/reviews/review-edit/components/edit-review-form/index.ts b/packages/admin/src/pages/reviews/review-edit/components/edit-review-form/index.ts
new file mode 100644
index 000000000..34be9dd42
--- /dev/null
+++ b/packages/admin/src/pages/reviews/review-edit/components/edit-review-form/index.ts
@@ -0,0 +1 @@
+export { EditReviewForm } from "./edit-review-form"
diff --git a/packages/admin/src/pages/reviews/review-edit/index.ts b/packages/admin/src/pages/reviews/review-edit/index.ts
new file mode 100644
index 000000000..ef21c9b6f
--- /dev/null
+++ b/packages/admin/src/pages/reviews/review-edit/index.ts
@@ -0,0 +1 @@
+export { ReviewEdit as Component } from "./review-edit"
diff --git a/packages/admin/src/pages/reviews/review-edit/review-edit.tsx b/packages/admin/src/pages/reviews/review-edit/review-edit.tsx
new file mode 100644
index 000000000..d76285a03
--- /dev/null
+++ b/packages/admin/src/pages/reviews/review-edit/review-edit.tsx
@@ -0,0 +1,33 @@
+import { Heading } from "@medusajs/ui"
+import { useTranslation } from "react-i18next"
+import { useParams } from "react-router-dom"
+
+import { RouteDrawer } from "../../../components/modals"
+import { VisuallyHidden } from "../../../components/utilities/visually-hidden"
+import { useReview } from "../../../hooks/api/reviews"
+import { EditReviewForm } from "./components/edit-review-form"
+
+export const ReviewEdit = () => {
+ const { t } = useTranslation()
+ const { id } = useParams()
+ const { review, isLoading, isError, error } = useReview(id!)
+
+ if (isError) {
+ throw error
+ }
+
+ return (
+ <RouteDrawer>
+ <RouteDrawer.Header>
+ <RouteDrawer.Title asChild>
+ <Heading>{t("reviews.edit.header")}</Heading>
+ </RouteDrawer.Title>
+ <RouteDrawer.Description asChild>
+ <VisuallyHidden>{t("reviews.edit.description")}</VisuallyHidden>
+ </RouteDrawer.Description>
+ </RouteDrawer.Header>
+
+ {!isLoading && review && <EditReviewForm review={review} />}
+ </RouteDrawer>
+ )
+}
diff --git a/packages/admin/src/pages/reviews/review-list/components/review-list-table.tsx b/packages/admin/src/pages/reviews/review-list/components/review-list-table.tsx
new file mode 100644
index 000000000..b9e8f08ee
--- /dev/null
+++ b/packages/admin/src/pages/reviews/review-list/components/review-list-table.tsx
@@ -0,0 +1,237 @@
+import { PencilSquare, Star, Trash } from "@medusajs/icons"
+import { Container, Heading, Text } from "@medusajs/ui"
+import { keepPreviousData } from "@tanstack/react-query"
+import { createColumnHelper } from "@tanstack/react-table"
+import { Children, ReactNode, useMemo } from "react"
+import { useTranslation } from "react-i18next"
+
+import { ActionMenu } from "../../../../components/common/action-menu"
+import { _DataTable } from "../../../../components/table/data-table"
+import { StatusCell } from "../../../../components/table/table-cells/common/status-cell"
+import { DateCell } from "../../../../components/table/table-cells/common/date-cell"
+import { useDataTable } from "../../../../hooks/use-data-table"
+import { AdminReview, useReviews } from "../../../../hooks/api/reviews"
+import { useDeleteReviewAction } from "../../common/hooks/use-delete-review-action"
+import { getReviewStatusColor, StarRating } from "../../common/utils"
+import { useReviewTableFilters } from "../use-review-table-filters"
+import { useReviewTableQuery } from "../use-review-table-query"
+
+const PAGE_SIZE = 20
+
+export const ReviewListTitle = () => {
+ const { t } = useTranslation()
+ return (
+ <Heading level="h2" data-testid="review-list-table-heading">
+ {t("reviews.domain")}
+ </Heading>
+ )
+}
+
+export const ReviewListHeader = ({ children }: { children?: ReactNode }) => {
+ return (
+ <div
+ className="flex items-center justify-between px-6 py-4"
+ data-testid="review-list-table-header"
+ >
+ {Children.count(children) > 0 ? children : <ReviewListTitle />}
+ </div>
+ )
+}
+
+const ReviewActions = ({ review }: { review: AdminReview }) => {
+ const { t } = useTranslation()
+ const handleDelete = useDeleteReviewAction(review.id)
+
+ return (
+ <ActionMenu
+ groups={[
+ {
+ actions: [
+ {
+ icon: <PencilSquare />,
+ label: t("actions.edit"),
+ to: `/reviews/${review.id}/edit`,
+ },
+ ],
+ },
+ {
+ actions: [
+ {
+ icon: <Trash />,
+ label: t("actions.delete"),
+ onClick: handleDelete,
+ },
+ ],
+ },
+ ]}
+ data-testid={`review-list-table-action-menu-${review.id}`}
+ />
+ )
+}
+
+const columnHelper = createColumnHelper<AdminReview>()
+
+const useColumns = () => {
+ const { t } = useTranslation()
+
+ return useMemo(
+ () => [
+ columnHelper.accessor("display_id", {
+ header: t("reviews.fields.id"),
+ cell: ({ getValue }) => (
+ <Text size="small" leading="compact" className="truncate">
+ #{getValue()}
+ </Text>
+ ),
+ }),
+ columnHelper.accessor("rating", {
+ header: t("reviews.fields.rating"),
+ cell: ({ getValue }) => <StarRating rating={getValue()} />,
+ }),
+ columnHelper.accessor("customer_note", {
+ header: t("reviews.fields.content"),
+ cell: ({ getValue }) => (
+ <div className="w-[240px]">
+ <Text
+ size="small"
+ leading="compact"
+ className="text-ui-fg-subtle line-clamp-3"
+ >
+ {getValue() || "-"}
+ </Text>
+ </div>
+ ),
+ }),
+ columnHelper.accessor("seller", {
+ header: t("reviews.fields.store"),
+ cell: ({ getValue }) => (
+ <Text size="small" leading="compact" className="truncate">
+ {getValue()?.name || "-"}
+ </Text>
+ ),
+ }),
+ columnHelper.accessor("customer", {
+ header: t("reviews.fields.customer"),
+ cell: ({ getValue }) => {
+ const customer = getValue()
+ const name = customer
+ ? [customer.first_name, customer.last_name].filter(Boolean).join(" ")
+ : ""
+ return (
+ <Text size="small" leading="compact" className="truncate">
+ {name || "-"}
+ </Text>
+ )
+ },
+ }),
+ columnHelper.accessor("created_at", {
+ header: t("reviews.fields.date"),
+ cell: ({ getValue }) => <DateCell date={getValue()} />,
+ }),
+ columnHelper.accessor("status", {
+ header: t("reviews.fields.status"),
+ cell: ({ getValue }) => {
+ const status = getValue()
+ return (
+ <StatusCell color={getReviewStatusColor(status)}>
+ {t(`reviews.status.${status}`)}
+ </StatusCell>
+ )
+ },
+ }),
+ columnHelper.accessor("seller_note", {
+ header: t("reviews.fields.response"),
+ cell: ({ getValue }) => (
+ <div className="w-[240px]">
+ <Text
+ size="small"
+ leading="compact"
+ className="text-ui-fg-subtle line-clamp-3"
+ >
+ {getValue() || "-"}
+ </Text>
+ </div>
+ ),
+ }),
+ columnHelper.display({
+ id: "actions",
+ cell: ({ row }) => <ReviewActions review={row.original} />,
+ }),
+ ],
+ [t]
+ )
+}
+
+export const ReviewListDataTable = () => {
+ const { t } = useTranslation()
+ const { raw, searchParams } = useReviewTableQuery({ pageSize: PAGE_SIZE })
+ const filters = useReviewTableFilters()
+
+ const { reviews, count, isPending, isError, error } = useReviews(
+ searchParams,
+ { placeholderData: keepPreviousData }
+ )
+
+ const columns = useColumns()
+
+ 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) => row.id}
+ isLoading={isPending}
+ queryObject={raw}
+ defaultOrder="-created_at"
+ orderBy={[
+ { key: "display_id", label: t("reviews.fields.id") },
+ { 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 />,
+ }}
+ noResults={{
+ icon: <Star />,
+ }}
+ data-testid="review-list-table"
+ />
+ )
+}
+
+export const ReviewListTable = ({ children }: { children?: ReactNode }) => {
+ return (
+ <Container
+ className="divide-y p-0"
+ data-testid="review-list-table-container"
+ >
+ {Children.count(children) > 0 ? (
+ children
+ ) : (
+ <>
+ <ReviewListHeader />
+ <ReviewListDataTable />
+ </>
+ )}
+ </Container>
+ )
+}
diff --git a/packages/admin/src/pages/reviews/review-list/index.ts b/packages/admin/src/pages/reviews/review-list/index.ts
new file mode 100644
index 000000000..60b4e86c6
--- /dev/null
+++ b/packages/admin/src/pages/reviews/review-list/index.ts
@@ -0,0 +1 @@
+export { ReviewListPage as Component } from "./review-list"
diff --git a/packages/admin/src/pages/reviews/review-list/review-list.tsx b/packages/admin/src/pages/reviews/review-list/review-list.tsx
new file mode 100644
index 000000000..2c237ea71
--- /dev/null
+++ b/packages/admin/src/pages/reviews/review-list/review-list.tsx
@@ -0,0 +1,24 @@
+import { Children, ReactNode } from "react"
+
+import { SingleColumnPage } from "../../../components/layout/pages"
+import {
+ ReviewListDataTable,
+ ReviewListHeader,
+ ReviewListTable,
+ ReviewListTitle,
+} 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,
+ HeaderTitle: ReviewListTitle,
+ DataTable: ReviewListDataTable,
+})
diff --git a/packages/admin/src/pages/reviews/review-list/use-review-table-filters.tsx b/packages/admin/src/pages/reviews/review-list/use-review-table-filters.tsx
new file mode 100644
index 000000000..5dfb003f0
--- /dev/null
+++ b/packages/admin/src/pages/reviews/review-list/use-review-table-filters.tsx
@@ -0,0 +1,83 @@
+import { useMemo } from "react"
+import { useTranslation } from "react-i18next"
+
+import { Filter } from "../../../components/table/data-table"
+import { useCustomers } from "../../../hooks/api/customers"
+import { useSellers } from "../../../hooks/api/sellers"
+
+export const useReviewTableFilters = (): Filter[] => {
+ const { t } = useTranslation()
+
+ const { sellers } = useSellers({ limit: 100, fields: "id,name" })
+ const { customers } = useCustomers({
+ limit: 100,
+ fields: "id,first_name,last_name,email",
+ })
+
+ return useMemo(() => {
+ const ratingFilter: Filter = {
+ key: "rating",
+ label: t("reviews.fields.rating"),
+ type: "select",
+ multiple: true,
+ options: [1, 2, 3, 4, 5].map((value) => ({
+ label: t("reviews.filters.stars", { count: value }),
+ value: String(value),
+ })),
+ }
+
+ const storeFilter: Filter = {
+ key: "seller_id",
+ label: t("reviews.fields.store"),
+ type: "select",
+ searchable: true,
+ options: (sellers ?? []).map((seller) => ({
+ label: seller.name!,
+ value: seller.id,
+ })),
+ }
+
+ const customerFilter: Filter = {
+ key: "customer_id",
+ label: t("reviews.fields.customer"),
+ type: "select",
+ searchable: true,
+ options: (customers ?? []).map((customer) => ({
+ label:
+ [customer.first_name, customer.last_name]
+ .filter(Boolean)
+ .join(" ") ||
+ customer.email ||
+ customer.id,
+ value: customer.id,
+ })),
+ }
+
+ const createdFilter: Filter = {
+ key: "created_at",
+ label: t("fields.createdAt"),
+ type: "date",
+ }
+
+ const statusFilter: Filter = {
+ key: "status",
+ label: t("reviews.fields.status"),
+ type: "select",
+ multiple: true,
+ options: (["pending", "published", "rejected"] as const).map(
+ (value) => ({
+ label: t(`reviews.status.${value}`),
+ value,
+ })
+ ),
+ }
+
+ return [
+ ratingFilter,
+ storeFilter,
+ customerFilter,
+ createdFilter,
+ statusFilter,
+ ]
+ }, [t, sellers, customers])
+}
diff --git a/packages/admin/src/pages/reviews/review-list/use-review-table-query.tsx b/packages/admin/src/pages/reviews/review-list/use-review-table-query.tsx
new file mode 100644
index 000000000..47f23ddae
--- /dev/null
+++ b/packages/admin/src/pages/reviews/review-list/use-review-table-query.tsx
@@ -0,0 +1,56 @@
+import { useQueryParams } from "../../../hooks/use-query-params"
+
+type UseReviewTableQueryProps = {
+ prefix?: string
+ pageSize?: number
+}
+
+export const useReviewTableQuery = ({
+ prefix,
+ pageSize = 20,
+}: UseReviewTableQueryProps) => {
+ const queryObject = useQueryParams(
+ [
+ "offset",
+ "q",
+ "order",
+ "created_at",
+ "updated_at",
+ "rating",
+ "status",
+ "seller_id",
+ "customer_id",
+ ],
+ prefix
+ )
+
+ const {
+ offset,
+ q,
+ order,
+ created_at,
+ updated_at,
+ rating,
+ status,
+ seller_id,
+ customer_id,
+ } = queryObject
+
+ const searchParams = {
+ limit: pageSize,
+ offset: offset ? Number(offset) : 0,
+ order: order ? order : "-created_at",
+ created_at: created_at ? JSON.parse(created_at) : undefined,
+ updated_at: updated_at ? JSON.parse(updated_at) : undefined,
+ rating: rating ? rating.split(",").map(Number) : undefined,
+ status: status ? status.split(",") : undefined,
+ seller_id: seller_id ? seller_id.split(",") : undefined,
+ customer_id: customer_id ? customer_id.split(",") : undefined,
+ q,
+ }
+
+ return {
+ searchParams,
+ raw: queryObject,
+ }
+}
diff --git a/packages/admin/src/pages/reviews/review-respond/components/respond-review-form/index.ts b/packages/admin/src/pages/reviews/review-respond/components/respond-review-form/index.ts
new file mode 100644
index 000000000..056ece48b
--- /dev/null
+++ b/packages/admin/src/pages/reviews/review-respond/components/respond-review-form/index.ts
@@ -0,0 +1 @@
+export { RespondReviewForm } from "./respond-review-form"
diff --git a/packages/admin/src/pages/reviews/review-respond/components/respond-review-form/respond-review-form.tsx b/packages/admin/src/pages/reviews/review-respond/components/respond-review-form/respond-review-form.tsx
new file mode 100644
index 000000000..184965031
--- /dev/null
+++ b/packages/admin/src/pages/reviews/review-respond/components/respond-review-form/respond-review-form.tsx
@@ -0,0 +1,100 @@
+import { Button, Textarea, toast } from "@medusajs/ui"
+import { useForm } from "react-hook-form"
+import { useTranslation } from "react-i18next"
+import { zodResolver } from "@hookform/resolvers/zod"
+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 { AdminReview, useRespondReview } from "../../../../../hooks/api/reviews"
+
+type RespondReviewFormValues = {
+ seller_note: string
+}
+
+export const RespondReviewForm = ({ review }: { review: AdminReview }) => {
+ const { t } = useTranslation()
+ const { handleSuccess } = useRouteModal()
+
+ const form = useForm<RespondReviewFormValues>({
+ defaultValues: {
+ seller_note: "",
+ },
+ resolver: zodResolver(
+ zod.object({
+ seller_note: zod
+ .string()
+ .min(1, t("reviews.respond.validation"))
+ .max(300),
+ })
+ ),
+ })
+
+ const { mutateAsync, isPending } = useRespondReview(review.id)
+
+ const handleSubmit = form.handleSubmit(async (data) => {
+ 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} data-testid="review-respond-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-response-input"
+ />
+ </Form.Control>
+ <Form.ErrorMessage />
+ </Form.Item>
+ )}
+ />
+ </div>
+ </RouteDrawer.Body>
+
+ <RouteDrawer.Footer>
+ <div className="flex items-center justify-end gap-x-2">
+ <RouteDrawer.Close asChild>
+ <Button
+ variant="secondary"
+ size="small"
+ data-testid="review-respond-form-cancel-button"
+ >
+ {t("actions.cancel")}
+ </Button>
+ </RouteDrawer.Close>
+ <Button
+ isLoading={isPending}
+ type="submit"
+ variant="primary"
+ size="small"
+ data-testid="review-respond-form-save-button"
+ >
+ {t("actions.save")}
+ </Button>
+ </div>
+ </RouteDrawer.Footer>
+ </KeyboundForm>
+ </RouteDrawer.Form>
+ )
+}
diff --git a/packages/admin/src/pages/reviews/review-respond/index.ts b/packages/admin/src/pages/reviews/review-respond/index.ts
new file mode 100644
index 000000000..1c3e63fbb
--- /dev/null
+++ b/packages/admin/src/pages/reviews/review-respond/index.ts
@@ -0,0 +1 @@
+export { ReviewRespond as Component } from "./review-respond"
diff --git a/packages/admin/src/pages/reviews/review-respond/review-respond.tsx b/packages/admin/src/pages/reviews/review-respond/review-respond.tsx
new file mode 100644
index 000000000..65f916dc6
--- /dev/null
+++ b/packages/admin/src/pages/reviews/review-respond/review-respond.tsx
@@ -0,0 +1,37 @@
+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 "./components/respond-review-form"
+
+export const ReviewRespond = () => {
+ 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.description")}</VisuallyHidden>
+ </RouteDrawer.Description>
+ </RouteDrawer.Header>
+
+ {!isLoading && review && <RespondReviewForm review={review} />}
+ </RouteDrawer>
+ )
+}
diff --git a/packages/cli/routes-manifest.json b/packages/cli/routes-manifest.json
index 354c6ca8a..39f39c254 100644
--- a/packages/cli/routes-manifest.json
+++ b/packages/cli/routes-manifest.json
@@ -231,6 +231,9 @@
"/admin/returns/:id/request-items/:action_id": "typeof import(\"@medusajs/medusa/api/admin/returns/[id]/request-items/[action_id]/route\")",
"/admin/returns/:id/shipping-method": "typeof import(\"@medusajs/medusa/api/admin/returns/[id]/shipping-method/route\")",
"/admin/returns/:id/shipping-method/:action_id": "typeof import(\"@medusajs/medusa/api/admin/returns/[id]/shipping-method/[action_id]/route\")",
+ "/admin/reviews": "typeof import(\"@mercurjs/core/api/admin/reviews/route\")",
+ "/admin/reviews/:id": "typeof import(\"@mercurjs/core/api/admin/reviews/[id]/route\")",
+ "/admin/reviews/:id/respond": "typeof import(\"@mercurjs/core/api/admin/reviews/[id]/respond/route\")",
"/admin/sales-channels": "typeof import(\"@medusajs/medusa/api/admin/sales-channels/route\")",
"/admin/sales-channels/:id": "typeof import(\"@medusajs/medusa/api/admin/sales-channels/[id]/route\")",
"/admin/sales-channels/:id/products": "typeof import(\"@medusajs/medusa/api/admin/sales-channels/[id]/products/route\")",
@@ -367,6 +370,8 @@
"/store/return-reasons": "typeof import(\"@medusajs/medusa/api/store/return-reasons/route\")",
"/store/return-reasons/:id": "typeof import(\"@medusajs/medusa/api/store/return-reasons/[id]/route\")",
"/store/returns": "typeof import(\"@medusajs/medusa/api/store/returns/route\")",
+ "/store/reviews": "typeof import(\"@mercurjs/core/api/store/reviews/route\")",
+ "/store/reviews/:id": "typeof import(\"@mercurjs/core/api/store/reviews/[id]/route\")",
"/store/sellers": "typeof import(\"@mercurjs/core/api/store/sellers/route\")",
"/store/sellers/:id": "typeof import(\"@mercurjs/core/api/store/sellers/[id]/route\")",
"/store/shipping-options": "typeof import(\"@mercurjs/core/api/store/shipping-options/route\")",
@@ -511,6 +516,8 @@
"/vendor/returns/:id/request-items/:action_id": "typeof import(\"@mercurjs/core/api/vendor/returns/[id]/request-items/[action_id]/route\")",
"/vendor/returns/:id/shipping-method": "typeof import(\"@mercurjs/core/api/vendor/returns/[id]/shipping-method/route\")",
"/vendor/returns/:id/shipping-method/:action_id": "typeof import(\"@mercurjs/core/api/vendor/returns/[id]/shipping-method/[action_id]/route\")",
+ "/vendor/reviews": "typeof import(\"@mercurjs/core/api/vendor/reviews/route\")",
+ "/vendor/reviews/:id": "typeof import(\"@mercurjs/core/api/vendor/reviews/[id]/route\")",
"/vendor/sales-channels": "typeof import(\"@mercurjs/core/api/vendor/sales-channels/route\")",
"/vendor/sales-channels/:id": "typeof import(\"@mercurjs/core/api/vendor/sales-channels/[id]/route\")",
"/vendor/sales-channels/:id/products": "typeof import(\"@mercurjs/core/api/vendor/sales-channels/[id]/products/route\")",
diff --git a/packages/core/.mercur/routes.d.ts b/packages/core/.mercur/routes.d.ts
index f8add48ac..0992d7d8b 100644
--- a/packages/core/.mercur/routes.d.ts
+++ b/packages/core/.mercur/routes.d.ts
@@ -509,6 +509,11 @@ export type Routes = {
subscribe: typeof import("@medusajs/medusa/api/admin/workflows-executions/[workflow_id]/subscribe/route");
};
};
+ reviews: typeof import("../src/api/admin/reviews/route") & {
+ $id: typeof import("../src/api/admin/reviews/[id]/route") & {
+ respond: typeof import("../src/api/admin/reviews/[id]/respond/route");
+ };
+ };
};
auth: {
$actorType: {
@@ -637,6 +642,9 @@ export type Routes = {
calculate: typeof import("@medusajs/medusa/api/store/shipping-options/[id]/calculate/route");
};
};
+ reviews: typeof import("../src/api/store/reviews/route") & {
+ $id: typeof import("../src/api/store/reviews/[id]/route");
+ };
};
vendor: {
campaigns: typeof import("../src/api/vendor/campaigns/route") & {
@@ -923,5 +931,8 @@ export type Routes = {
};
stores: typeof import("../src/api/vendor/stores/route");
uploads: typeof import("../src/api/vendor/uploads/route");
+ reviews: typeof import("../src/api/vendor/reviews/route") & {
+ $id: typeof import("../src/api/vendor/reviews/[id]/route");
+ };
};
};
diff --git a/packages/core/src/api/admin/middlewares.ts b/packages/core/src/api/admin/middlewares.ts
index b504dde83..c94574bf2 100644
--- a/packages/core/src/api/admin/middlewares.ts
+++ b/packages/core/src/api/admin/middlewares.ts
@@ -22,6 +22,7 @@ import { adminProductChangesMiddlewares } from "./product-changes/middlewares"
import { adminStockLocationsMiddlewares } from "./stock-locations/middlewares"
import { adminShippingOptionsMiddlewares } from "./shipping-options/middlewares"
import { adminShippingProfilesMiddlewares } from "./shipping-profiles/middlewares"
+import { adminReviewsMiddlewares } from "./reviews/middlewares"
export const adminMiddlewares: MiddlewareRoute[] = [
...adminOrderGroupsMiddlewares,
@@ -52,4 +53,5 @@ export const adminMiddlewares: MiddlewareRoute[] = [
...adminStockLocationsMiddlewares,
...adminShippingOptionsMiddlewares,
...adminShippingProfilesMiddlewares,
+ ...adminReviewsMiddlewares,
]
diff --git a/packages/core/src/api/admin/reviews/[id]/respond/route.ts b/packages/core/src/api/admin/reviews/[id]/respond/route.ts
new file mode 100644
index 000000000..6bc454fb4
--- /dev/null
+++ b/packages/core/src/api/admin/reviews/[id]/respond/route.ts
@@ -0,0 +1,32 @@
+import { AuthenticatedMedusaRequest, MedusaResponse } from "@medusajs/framework"
+import { ContainerRegistrationKeys } from "@medusajs/framework/utils"
+import { AdminReviewResponse } from "@mercurjs/types"
+
+import { respondReviewWorkflow } from "../../../../../workflows/review/workflows"
+import { AdminRespondReviewType } from "../../validators"
+
+export async function POST(
+ req: AuthenticatedMedusaRequest<AdminRespondReviewType>,
+ res: MedusaResponse<AdminReviewResponse>
+): Promise<void> {
+ const { id } = req.params
+
+ await respondReviewWorkflow.run({
+ container: req.scope,
+ input: { id: id!, seller_note: req.validatedBody.seller_note },
+ })
+
+ const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)
+
+ const {
+ data: [review],
+ } = await query.graph({
+ entity: "review",
+ fields: req.queryConfig.fields,
+ filters: {
+ id,
+ },
+ })
+
+ res.json({ review })
+}
diff --git a/packages/core/src/api/admin/reviews/[id]/route.ts b/packages/core/src/api/admin/reviews/[id]/route.ts
new file mode 100644
index 000000000..4c5f2ab85
--- /dev/null
+++ b/packages/core/src/api/admin/reviews/[id]/route.ts
@@ -0,0 +1,75 @@
+import { AuthenticatedMedusaRequest, MedusaResponse } from "@medusajs/framework"
+import { ContainerRegistrationKeys } from "@medusajs/framework/utils"
+import {
+ AdminReviewDeleteResponse,
+ AdminReviewResponse,
+} from "@mercurjs/types"
+
+import {
+ deleteReviewWorkflow,
+ updateReviewWorkflow,
+} from "../../../../workflows/review/workflows"
+import { AdminUpdateReviewType } from "../validators"
+
+export async function GET(
+ req: AuthenticatedMedusaRequest,
+ res: MedusaResponse<AdminReviewResponse>
+): Promise<void> {
+ const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)
+
+ const {
+ data: [review],
+ } = await query.graph({
+ entity: "review",
+ fields: req.queryConfig.fields,
+ filters: {
+ id: req.params.id,
+ },
+ })
+
+ res.json({ review })
+}
+
+export async function POST(
+ req: AuthenticatedMedusaRequest<AdminUpdateReviewType>,
+ res: MedusaResponse<AdminReviewResponse>
+): Promise<void> {
+ const { id } = req.params
+
+ await updateReviewWorkflow.run({
+ container: req.scope,
+ input: { id, ...req.validatedBody },
+ })
+
+ const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)
+
+ const {
+ data: [review],
+ } = await query.graph({
+ entity: "review",
+ fields: req.queryConfig.fields,
+ filters: {
+ id,
+ },
+ })
+
+ res.json({ review })
+}
+
+export async function DELETE(
+ req: AuthenticatedMedusaRequest,
+ res: MedusaResponse<AdminReviewDeleteResponse>
+): Promise<void> {
+ const { id } = req.params
+
+ await deleteReviewWorkflow.run({
+ container: req.scope,
+ input: id!,
+ })
+
+ res.json({
+ id: id!,
+ object: "review",
+ deleted: true,
+ })
+}
diff --git a/packages/core/src/api/admin/reviews/middlewares.ts b/packages/core/src/api/admin/reviews/middlewares.ts
new file mode 100644
index 000000000..9f27da2b9
--- /dev/null
+++ b/packages/core/src/api/admin/reviews/middlewares.ts
@@ -0,0 +1,69 @@
+import { validateAndTransformBody, validateAndTransformQuery } from "@medusajs/framework"
+import { maybeApplyLinkFilter } from "@medusajs/framework/http"
+import { MiddlewareRoute } from "@medusajs/medusa"
+
+import customerReview from "../../../links/customer-review"
+import sellerReview from "../../../links/seller-review"
+import { adminReviewsConfig } from "./query-config"
+import {
+ AdminGetReviewsParams,
+ AdminRespondReview,
+ AdminUpdateReview,
+} from "./validators"
+
+export const adminReviewsMiddlewares: MiddlewareRoute[] = [
+ {
+ method: ["GET"],
+ matcher: "/admin/reviews",
+ middlewares: [
+ validateAndTransformQuery(AdminGetReviewsParams, adminReviewsConfig.list),
+ maybeApplyLinkFilter({
+ entryPoint: sellerReview.entryPoint,
+ resourceId: "review_id",
+ filterableField: "seller_id",
+ }),
+ maybeApplyLinkFilter({
+ entryPoint: customerReview.entryPoint,
+ resourceId: "review_id",
+ filterableField: "customer_id",
+ }),
+ ],
+ },
+ {
+ method: ["GET"],
+ matcher: "/admin/reviews/:id",
+ middlewares: [
+ validateAndTransformQuery(
+ AdminGetReviewsParams,
+ adminReviewsConfig.retrieve
+ ),
+ ],
+ },
+ {
+ method: ["POST"],
+ matcher: "/admin/reviews/:id",
+ middlewares: [
+ validateAndTransformQuery(
+ AdminGetReviewsParams,
+ adminReviewsConfig.retrieve
+ ),
+ validateAndTransformBody(AdminUpdateReview),
+ ],
+ },
+ {
+ method: ["POST"],
+ matcher: "/admin/reviews/:id/respond",
+ middlewares: [
+ validateAndTransformQuery(
+ AdminGetReviewsParams,
+ adminReviewsConfig.retrieve
+ ),
+ validateAndTransformBody(AdminRespondReview),
+ ],
+ },
+ {
+ method: ["DELETE"],
+ matcher: "/admin/reviews/:id",
+ middlewares: [],
+ },
+]
diff --git a/packages/core/src/api/admin/reviews/query-config.ts b/packages/core/src/api/admin/reviews/query-config.ts
new file mode 100644
index 000000000..bf7859804
--- /dev/null
+++ b/packages/core/src/api/admin/reviews/query-config.ts
@@ -0,0 +1,32 @@
+export const adminReviewsFields = [
+ "id",
+ "display_id",
+ "reference",
+ "rating",
+ "customer_note",
+ "seller_note",
+ "status",
+ "created_at",
+ "updated_at",
+ "customer.id",
+ "customer.first_name",
+ "customer.last_name",
+ "customer.email",
+ "order.id",
+ "order.display_id",
+ "order.created_at",
+ "seller.id",
+ "seller.name",
+ "seller.email",
+]
+
+export const adminReviewsConfig = {
+ list: {
+ defaults: adminReviewsFields,
+ isList: true,
+ },
+ retrieve: {
+ defaults: adminReviewsFields,
+ isList: false,
+ },
+}
diff --git a/packages/registry/src/reviews/api/admin/reviews/route.ts b/packages/core/src/api/admin/reviews/route.ts
similarity index 57%
rename from packages/registry/src/reviews/api/admin/reviews/route.ts
rename to packages/core/src/api/admin/reviews/route.ts
index ff51f1a01..0d8d946b1 100644
--- a/packages/registry/src/reviews/api/admin/reviews/route.ts
+++ b/packages/core/src/api/admin/reviews/route.ts
@@ -1,24 +1,24 @@
-import { MedusaRequest, MedusaResponse } from '@medusajs/framework'
-import { ContainerRegistrationKeys } from '@medusajs/framework/utils'
-
-import { AdminReviewListResponse } from '../../../modules/reviews/types'
+import { MedusaRequest, MedusaResponse } from "@medusajs/framework"
+import { ContainerRegistrationKeys } from "@medusajs/framework/utils"
+import { AdminReviewListResponse } from "@mercurjs/types"
export async function GET(
req: MedusaRequest,
res: MedusaResponse<AdminReviewListResponse>
): Promise<void> {
const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)
+
const { data: reviews, metadata } = await query.graph({
- entity: 'review',
+ entity: "review",
fields: req.queryConfig.fields,
filters: req.filterableFields,
- pagination: req.queryConfig.pagination
+ pagination: req.queryConfig.pagination,
})
res.json({
reviews,
count: metadata?.count ?? 0,
offset: metadata?.skip ?? 0,
- limit: metadata?.take ?? 0
+ limit: metadata?.take ?? 0,
})
}
diff --git a/packages/core/src/api/admin/reviews/validators.ts b/packages/core/src/api/admin/reviews/validators.ts
new file mode 100644
index 000000000..60ef2ef4b
--- /dev/null
+++ b/packages/core/src/api/admin/reviews/validators.ts
@@ -0,0 +1,38 @@
+import { z } from "zod"
+
+import { createFindParams } from "@medusajs/medusa/api/utils/validators"
+
+export type AdminGetReviewsParamsType = z.infer<typeof AdminGetReviewsParams>
+export const AdminGetReviewsParams = createFindParams({
+ offset: 0,
+ limit: 50,
+}).extend({
+ q: z.string().optional(),
+ seller_id: z.union([z.string(), z.array(z.string())]).optional(),
+ customer_id: z.union([z.string(), z.array(z.string())]).optional(),
+ reference: z.enum(["product", "seller"]).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),
+ z.array(z.coerce.number().int().min(1).max(5)),
+ ])
+ .optional(),
+})
+
+export type AdminUpdateReviewType = z.infer<typeof AdminUpdateReview>
+export const AdminUpdateReview = z.object({
+ rating: z.number().int().min(1).max(5).optional(),
+ customer_note: z.string().max(1000).optional(),
+ status: z.enum(["pending", "published", "rejected"]).optional(),
+})
+
+export type AdminRespondReviewType = z.infer<typeof AdminRespondReview>
+export const AdminRespondReview = z.object({
+ seller_note: z.string().min(1).max(300),
+})
diff --git a/packages/core/src/api/store/middlewares.ts b/packages/core/src/api/store/middlewares.ts
index 0366c99a5..e3ad4dcdd 100644
--- a/packages/core/src/api/store/middlewares.ts
+++ b/packages/core/src/api/store/middlewares.ts
@@ -7,6 +7,7 @@ import { storeProductAttributesMiddlewares } from "./product-attributes/middlewa
import { storeProductCategoriesMiddlewares } from "./product-categories/middlewares"
import { storeProductsMiddlewares } from "./products/middlewares"
import { storeSellersMiddlewares } from "./sellers/middlewares"
+import { storeReviewsMiddlewares } from "./reviews/middlewares"
export const storeMiddlewares: MiddlewareRoute[] = [
...storeCartsMiddlewares,
@@ -16,4 +17,5 @@ export const storeMiddlewares: MiddlewareRoute[] = [
...storeProductCategoriesMiddlewares,
...storeProductsMiddlewares,
...storeSellersMiddlewares,
+ ...storeReviewsMiddlewares,
]
diff --git a/packages/registry/src/reviews/api/store/reviews/[id]/route.ts b/packages/core/src/api/store/reviews/[id]/route.ts
similarity index 60%
rename from packages/registry/src/reviews/api/store/reviews/[id]/route.ts
rename to packages/core/src/api/store/reviews/[id]/route.ts
index 8e8fa5111..bc8be1b7b 100644
--- a/packages/registry/src/reviews/api/store/reviews/[id]/route.ts
+++ b/packages/core/src/api/store/reviews/[id]/route.ts
@@ -1,13 +1,16 @@
-import { AuthenticatedMedusaRequest, MedusaResponse } from '@medusajs/framework'
-import { ContainerRegistrationKeys } from '@medusajs/framework/utils'
+import { AuthenticatedMedusaRequest, MedusaResponse } from "@medusajs/framework"
+import { ContainerRegistrationKeys } from "@medusajs/framework/utils"
+import {
+ StoreReviewDeleteResponse,
+ StoreReviewResponse,
+} from "@mercurjs/types"
-import { StoreReviewDeleteResponse, StoreReviewResponse } from '../../../../modules/reviews/types'
import {
deleteReviewWorkflow,
- updateReviewWorkflow
-} from '../../../../workflows/review/workflows'
-import { validateCustomerReview } from '../helpers'
-import { StoreGetReviewsParamsType, StoreUpdateReviewType } from '../validators'
+ updateReviewWorkflow,
+} from "../../../../workflows/review/workflows"
+import { validateCustomerReview } from "../helpers"
+import { StoreUpdateReviewType } from "../validators"
export const POST = async (
req: AuthenticatedMedusaRequest<StoreUpdateReviewType>,
@@ -17,26 +20,24 @@ export const POST = async (
await validateCustomerReview(req.scope, req.auth_context.actor_id, id!)
- const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)
-
await updateReviewWorkflow.run({
container: req.scope,
- input: { id, ...req.validatedBody }
+ input: { id: id!, ...req.validatedBody },
})
+ const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)
+
const {
- data: [review]
+ data: [review],
} = await query.graph({
- entity: 'review',
+ entity: "review",
fields: req.queryConfig.fields,
filters: {
- id
- }
+ id,
+ },
})
- res.json({
- review
- })
+ res.json({ review })
}
export const DELETE = async (
@@ -49,18 +50,18 @@ export const DELETE = async (
await deleteReviewWorkflow.run({
container: req.scope,
- input: id
+ input: id!,
})
res.json({
id: id!,
- object: 'review',
- deleted: true
+ object: "review",
+ deleted: true,
})
}
export const GET = async (
- req: AuthenticatedMedusaRequest<StoreGetReviewsParamsType>,
+ req: AuthenticatedMedusaRequest,
res: MedusaResponse<StoreReviewResponse>
) => {
const { id } = req.params
@@ -70,16 +71,14 @@ export const GET = async (
const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)
const {
- data: [review]
+ data: [review],
} = await query.graph({
- entity: 'review',
+ entity: "review",
fields: req.queryConfig.fields,
filters: {
- id
- }
+ id,
+ },
})
- res.json({
- review
- })
+ res.json({ review })
}
diff --git a/packages/registry/src/reviews/api/store/reviews/helpers.ts b/packages/core/src/api/store/reviews/helpers.ts
similarity index 100%
rename from packages/registry/src/reviews/api/store/reviews/helpers.ts
rename to packages/core/src/api/store/reviews/helpers.ts
diff --git a/packages/registry/src/reviews/api/store/reviews/middlewares.ts b/packages/core/src/api/store/reviews/middlewares.ts
similarity index 81%
rename from packages/registry/src/reviews/api/store/reviews/middlewares.ts
rename to packages/core/src/api/store/reviews/middlewares.ts
index ced14d3c7..86da2ff95 100644
--- a/packages/registry/src/reviews/api/store/reviews/middlewares.ts
+++ b/packages/core/src/api/store/reviews/middlewares.ts
@@ -2,17 +2,17 @@ import {
authenticate,
validateAndTransformBody,
validateAndTransformQuery,
-} from "@medusajs/framework";
-import { MiddlewareRoute } from "@medusajs/medusa";
+} from "@medusajs/framework"
+import { MiddlewareRoute } from "@medusajs/medusa"
-import { storeReviewQueryConfig } from "./query-config";
+import { storeReviewQueryConfig } from "./query-config"
import {
StoreCreateReview,
StoreGetReviewsParams,
StoreUpdateReview,
-} from "./validators";
+} from "./validators"
-export const storeReviewMiddlewares: MiddlewareRoute[] = [
+export const storeReviewsMiddlewares: MiddlewareRoute[] = [
{
method: ["GET"],
matcher: "/store/reviews",
@@ -50,9 +50,7 @@ export const storeReviewMiddlewares: MiddlewareRoute[] = [
{
method: ["DELETE"],
matcher: "/store/reviews/:id",
- middlewares: [
- authenticate("customer", ["session", "bearer"]),
- ],
+ middlewares: [authenticate("customer", ["session", "bearer"])],
},
{
method: ["POST"],
@@ -66,4 +64,4 @@ export const storeReviewMiddlewares: MiddlewareRoute[] = [
validateAndTransformBody(StoreUpdateReview),
],
},
-];
+]
diff --git a/packages/core/src/api/store/reviews/query-config.ts b/packages/core/src/api/store/reviews/query-config.ts
new file mode 100644
index 000000000..b9129eec2
--- /dev/null
+++ b/packages/core/src/api/store/reviews/query-config.ts
@@ -0,0 +1,24 @@
+export const storeReviewFields = [
+ "id",
+ "display_id",
+ "reference",
+ "rating",
+ "customer_note",
+ "seller_note",
+ "status",
+ "customer.first_name",
+ "customer.last_name",
+ "created_at",
+ "updated_at",
+]
+
+export const storeReviewQueryConfig = {
+ list: {
+ defaults: storeReviewFields,
+ isList: true,
+ },
+ retrieve: {
+ defaults: storeReviewFields,
+ isList: false,
+ },
+}
diff --git a/packages/registry/src/reviews/api/store/reviews/route.ts b/packages/core/src/api/store/reviews/route.ts
similarity index 82%
rename from packages/registry/src/reviews/api/store/reviews/route.ts
rename to packages/core/src/api/store/reviews/route.ts
index addc32945..88c4e540a 100644
--- a/packages/registry/src/reviews/api/store/reviews/route.ts
+++ b/packages/core/src/api/store/reviews/route.ts
@@ -1,13 +1,16 @@
import {
AuthenticatedMedusaRequest,
MedusaResponse,
-} from "@medusajs/framework";
-import { ContainerRegistrationKeys } from "@medusajs/framework/utils";
+} from "@medusajs/framework"
+import { ContainerRegistrationKeys } from "@medusajs/framework/utils"
+import {
+ StoreReviewListResponse,
+ StoreReviewResponse,
+} from "@mercurjs/types"
-import customerReview from "../../../links/customer-review";
-import { StoreReviewListResponse, StoreReviewResponse } from "../../../modules/reviews/types";
-import { createReviewWorkflow } from "../../../workflows/review/workflows";
-import { StoreCreateReviewType, StoreGetReviewsParamsType } from "./validators";
+import customerReview from "../../../links/customer-review"
+import { createReviewWorkflow } from "../../../workflows/review/workflows"
+import { StoreCreateReviewType, StoreGetReviewsParamsType } from "./validators"
export const POST = async (
req: AuthenticatedMedusaRequest<StoreCreateReviewType>,
@@ -19,9 +22,9 @@ export const POST = async (
...req.validatedBody,
customer_id: req.auth_context.actor_id,
},
- });
+ })
- const query = req.scope.resolve(ContainerRegistrationKeys.QUERY);
+ const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)
const {
data: [review],
@@ -31,16 +34,16 @@ export const POST = async (
filters: {
id: result.id,
},
- });
+ })
- res.status(201).json({ review });
-};
+ res.status(201).json({ review })
+}
export const GET = async (
req: AuthenticatedMedusaRequest<StoreGetReviewsParamsType>,
res: MedusaResponse<StoreReviewListResponse>
) => {
- const query = req.scope.resolve(ContainerRegistrationKeys.QUERY);
+ const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)
const { data: reviews, metadata } = await query.graph({
entity: customerReview.entryPoint,
@@ -49,12 +52,12 @@ export const GET = async (
customer_id: req.auth_context.actor_id,
},
pagination: req.queryConfig.pagination,
- });
+ })
res.json({
reviews: reviews.map((relation) => relation.review),
count: metadata?.count ?? 0,
offset: metadata?.skip ?? 0,
limit: metadata?.take ?? 0,
- });
-};
+ })
+}
diff --git a/packages/registry/src/reviews/api/store/reviews/validators.ts b/packages/core/src/api/store/reviews/validators.ts
similarity index 67%
rename from packages/registry/src/reviews/api/store/reviews/validators.ts
rename to packages/core/src/api/store/reviews/validators.ts
index 61d5ecfb6..9d1fe4bdf 100644
--- a/packages/registry/src/reviews/api/store/reviews/validators.ts
+++ b/packages/core/src/api/store/reviews/validators.ts
@@ -1,24 +1,24 @@
-import { z } from 'zod'
+import { z } from "zod"
-import { createFindParams } from '@medusajs/medusa/api/utils/validators'
+import { createFindParams } from "@medusajs/medusa/api/utils/validators"
export type StoreGetReviewsParamsType = z.infer<typeof StoreGetReviewsParams>
export const StoreGetReviewsParams = createFindParams({
offset: 0,
- limit: 50
+ limit: 50,
})
export type StoreCreateReviewType = z.infer<typeof StoreCreateReview>
export const StoreCreateReview = z.object({
order_id: z.string(),
- reference: z.enum(['seller', 'product']),
+ reference: z.enum(["seller", "product"]),
reference_id: z.string(),
rating: z.number().int().min(1).max(5),
- customer_note: z.string().max(300).nullable()
+ customer_note: z.string().max(300).nullish(),
})
export type StoreUpdateReviewType = z.infer<typeof StoreUpdateReview>
export const StoreUpdateReview = z.object({
rating: z.number().int().min(1).max(5),
- customer_note: z.string().max(300).nullable()
+ customer_note: z.string().max(300).nullish(),
})
diff --git a/packages/core/src/api/vendor/middlewares.ts b/packages/core/src/api/vendor/middlewares.ts
index 228df4863..2e7f47a34 100644
--- a/packages/core/src/api/vendor/middlewares.ts
+++ b/packages/core/src/api/vendor/middlewares.ts
@@ -43,6 +43,7 @@ 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$/,
@@ -127,4 +128,5 @@ export const vendorMiddlewares: MiddlewareRoute[] = [
...vendorStoresMiddlewares,
...vendorUploadsMiddlewares,
...vendorProductTagsMiddlewares,
+ ...vendorReviewsMiddlewares,
]
diff --git a/packages/core/src/api/vendor/reviews/[id]/route.ts b/packages/core/src/api/vendor/reviews/[id]/route.ts
new file mode 100644
index 000000000..0ca3f4cff
--- /dev/null
+++ b/packages/core/src/api/vendor/reviews/[id]/route.ts
@@ -0,0 +1,58 @@
+import { AuthenticatedMedusaRequest, MedusaResponse } from "@medusajs/framework"
+import { ContainerRegistrationKeys } from "@medusajs/framework/utils"
+import { VendorReviewResponse } from "@mercurjs/types"
+
+import { respondReviewWorkflow } from "../../../../workflows/review/workflows"
+import { validateSellerReview } from "../helpers"
+import { VendorRespondReviewType } from "../validators"
+
+export const GET = async (
+ req: AuthenticatedMedusaRequest,
+ res: MedusaResponse<VendorReviewResponse>
+) => {
+ const { id } = req.params
+
+ await validateSellerReview(req.scope, req.seller_context!.seller_id, id!)
+
+ const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)
+
+ const {
+ data: [review],
+ } = await query.graph({
+ entity: "review",
+ fields: req.queryConfig.fields,
+ filters: {
+ id,
+ },
+ })
+
+ res.json({ review })
+}
+
+export const POST = async (
+ req: AuthenticatedMedusaRequest<VendorRespondReviewType>,
+ res: MedusaResponse<VendorReviewResponse>
+) => {
+ const { id } = req.params
+
+ await validateSellerReview(req.scope, req.seller_context!.seller_id, id!)
+
+ await respondReviewWorkflow.run({
+ container: req.scope,
+ input: { id: id!, seller_note: req.validatedBody.seller_note },
+ })
+
+ const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)
+
+ const {
+ data: [review],
+ } = await query.graph({
+ entity: "review",
+ fields: req.queryConfig.fields,
+ filters: {
+ id,
+ },
+ })
+
+ res.json({ review })
+}
diff --git a/packages/registry/src/reviews/api/vendor/reviews/helpers.ts b/packages/core/src/api/vendor/reviews/helpers.ts
similarity index 100%
rename from packages/registry/src/reviews/api/vendor/reviews/helpers.ts
rename to packages/core/src/api/vendor/reviews/helpers.ts
diff --git a/packages/registry/src/reviews/api/vendor/reviews/middlewares.ts b/packages/core/src/api/vendor/reviews/middlewares.ts
similarity index 74%
rename from packages/registry/src/reviews/api/vendor/reviews/middlewares.ts
rename to packages/core/src/api/vendor/reviews/middlewares.ts
index 981389e01..11f284538 100644
--- a/packages/registry/src/reviews/api/vendor/reviews/middlewares.ts
+++ b/packages/core/src/api/vendor/reviews/middlewares.ts
@@ -4,29 +4,29 @@ import {
MedusaNextFunction,
MedusaResponse,
MiddlewareRoute,
-} from "@medusajs/framework/http";
+} from "@medusajs/framework/http"
import {
validateAndTransformBody,
validateAndTransformQuery,
-} from "@medusajs/framework";
+} from "@medusajs/framework"
-import sellerReview from "../../../links/seller-review";
-import { vendorReviewQueryConfig } from "./query-config";
-import { VendorGetReviewsParams, VendorUpdateReview } from "./validators";
+import sellerReview from "../../../links/seller-review"
+import { vendorReviewQueryConfig } from "./query-config"
+import { VendorGetReviewsParams, VendorRespondReview } from "./validators"
const applySellerReviewLinkFilter = (
req: AuthenticatedMedusaRequest,
res: MedusaResponse,
next: MedusaNextFunction
) => {
- req.filterableFields.seller_id = req.auth_context.actor_id;
+ req.filterableFields.seller_id = req.seller_context!.seller_id
return maybeApplyLinkFilter({
entryPoint: sellerReview.entryPoint,
resourceId: "review_id",
filterableField: "seller_id",
- })(req, res, next);
-};
+ })(req, res, next)
+}
export const vendorReviewsMiddlewares: MiddlewareRoute[] = [
{
@@ -58,7 +58,7 @@ export const vendorReviewsMiddlewares: MiddlewareRoute[] = [
VendorGetReviewsParams,
vendorReviewQueryConfig.retrieve
),
- validateAndTransformBody(VendorUpdateReview),
+ validateAndTransformBody(VendorRespondReview),
],
},
-];
+]
diff --git a/packages/registry/src/reviews/api/vendor/reviews/query-config.ts b/packages/core/src/api/vendor/reviews/query-config.ts
similarity index 61%
rename from packages/registry/src/reviews/api/vendor/reviews/query-config.ts
rename to packages/core/src/api/vendor/reviews/query-config.ts
index b40867bd1..dc67b0a1e 100644
--- a/packages/registry/src/reviews/api/vendor/reviews/query-config.ts
+++ b/packages/core/src/api/vendor/reviews/query-config.ts
@@ -1,12 +1,21 @@
export const vendorReviewFields = [
"id",
+ "display_id",
+ "reference",
"rating",
"customer_note",
- "customer_id",
"seller_note",
+ "status",
"created_at",
"updated_at",
-];
+ "customer.id",
+ "customer.first_name",
+ "customer.last_name",
+ "customer.email",
+ "order.id",
+ "order.display_id",
+ "order.created_at",
+]
export const vendorReviewQueryConfig = {
list: {
@@ -17,4 +26,4 @@ export const vendorReviewQueryConfig = {
defaults: vendorReviewFields,
isList: false,
},
-};
+}
diff --git a/packages/registry/src/reviews/api/vendor/reviews/route.ts b/packages/core/src/api/vendor/reviews/route.ts
similarity index 60%
rename from packages/registry/src/reviews/api/vendor/reviews/route.ts
rename to packages/core/src/api/vendor/reviews/route.ts
index d99063f7f..cda8ea342 100644
--- a/packages/registry/src/reviews/api/vendor/reviews/route.ts
+++ b/packages/core/src/api/vendor/reviews/route.ts
@@ -1,8 +1,8 @@
-import { AuthenticatedMedusaRequest, MedusaResponse } from '@medusajs/framework'
-import { ContainerRegistrationKeys } from '@medusajs/framework/utils'
+import { AuthenticatedMedusaRequest, MedusaResponse } from "@medusajs/framework"
+import { ContainerRegistrationKeys } from "@medusajs/framework/utils"
+import { VendorReviewListResponse } from "@mercurjs/types"
-import sellerReview from '../../../links/seller-review'
-import { VendorReviewListResponse } from '../../../modules/reviews/types'
+import sellerReview from "../../../links/seller-review"
export const GET = async (
req: AuthenticatedMedusaRequest,
@@ -14,13 +14,13 @@ export const GET = async (
entity: sellerReview.entryPoint,
fields: req.queryConfig.fields.map((field) => `review.${field}`),
filters: req.filterableFields,
- pagination: req.queryConfig.pagination
+ pagination: req.queryConfig.pagination,
})
res.json({
reviews: reviews.map((relation) => relation.review),
count: metadata?.count ?? 0,
offset: metadata?.skip ?? 0,
- limit: metadata?.take ?? 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
new file mode 100644
index 000000000..c47b17ea6
--- /dev/null
+++ b/packages/core/src/api/vendor/reviews/validators.ts
@@ -0,0 +1,20 @@
+import { z } from "zod"
+import { createFindParams } from "@medusajs/medusa/api/utils/validators"
+
+export type VendorGetReviewsParamsType = z.infer<typeof VendorGetReviewsParams>
+export const VendorGetReviewsParams = createFindParams({
+ offset: 0,
+ limit: 50,
+}).extend({
+ rating: z
+ .union([
+ z.coerce.number().int().min(1).max(5),
+ z.array(z.coerce.number().int().min(1).max(5)),
+ ])
+ .optional(),
+})
+
+export type VendorRespondReviewType = z.infer<typeof VendorRespondReview>
+export const VendorRespondReview = z.object({
+ seller_note: z.string().min(1).max(300),
+})
diff --git a/packages/core/src/links/customer-review.ts b/packages/core/src/links/customer-review.ts
new file mode 100644
index 000000000..1562cbacf
--- /dev/null
+++ b/packages/core/src/links/customer-review.ts
@@ -0,0 +1,9 @@
+import { defineLink } from "@medusajs/framework/utils"
+import CustomerModule from "@medusajs/medusa/customer"
+
+import ReviewModule from "../modules/review"
+
+export default defineLink(CustomerModule.linkable.customer, {
+ linkable: ReviewModule.linkable.review,
+ isList: true,
+})
diff --git a/packages/core/src/links/order-review.ts b/packages/core/src/links/order-review.ts
new file mode 100644
index 000000000..254308058
--- /dev/null
+++ b/packages/core/src/links/order-review.ts
@@ -0,0 +1,9 @@
+import { defineLink } from "@medusajs/framework/utils"
+import OrderModule from "@medusajs/medusa/order"
+
+import ReviewModule from "../modules/review"
+
+export default defineLink(OrderModule.linkable.order, {
+ linkable: ReviewModule.linkable.review,
+ isList: true,
+})
diff --git a/packages/core/src/links/product-review.ts b/packages/core/src/links/product-review.ts
new file mode 100644
index 000000000..b8fb20b47
--- /dev/null
+++ b/packages/core/src/links/product-review.ts
@@ -0,0 +1,9 @@
+import { defineLink } from "@medusajs/framework/utils"
+import ProductModule from "@medusajs/medusa/product"
+
+import ReviewModule from "../modules/review"
+
+export default defineLink(ProductModule.linkable.product, {
+ linkable: ReviewModule.linkable.review,
+ isList: true,
+})
diff --git a/packages/core/src/links/seller-review.ts b/packages/core/src/links/seller-review.ts
new file mode 100644
index 000000000..18814f611
--- /dev/null
+++ b/packages/core/src/links/seller-review.ts
@@ -0,0 +1,9 @@
+import { defineLink } from "@medusajs/framework/utils"
+
+import SellerModule from "../modules/seller"
+import ReviewModule from "../modules/review"
+
+export default defineLink(SellerModule.linkable.seller, {
+ linkable: ReviewModule.linkable.review,
+ isList: true,
+})
diff --git a/packages/core/src/modules/review/index.ts b/packages/core/src/modules/review/index.ts
new file mode 100644
index 000000000..3e39e6757
--- /dev/null
+++ b/packages/core/src/modules/review/index.ts
@@ -0,0 +1,8 @@
+import { Module } from "@medusajs/framework/utils"
+import { MercurModules } from "@mercurjs/types"
+
+import ReviewModuleService from "./service"
+
+export default Module(MercurModules.REVIEW, {
+ service: ReviewModuleService,
+})
diff --git a/packages/core/src/modules/review/migrations/Migration20260729120000.ts b/packages/core/src/modules/review/migrations/Migration20260729120000.ts
new file mode 100644
index 000000000..9fd9cb682
--- /dev/null
+++ b/packages/core/src/modules/review/migrations/Migration20260729120000.ts
@@ -0,0 +1,19 @@
+import { Migration } from "@medusajs/framework/mikro-orm/migrations"
+
+export class Migration20260729120000 extends Migration {
+ override async up(): Promise<void> {
+ this.addSql(
+ `create table if not exists "review" ("id" text not null, "display_id" serial, "reference" text check ("reference" in ('product', 'seller')) not null, "rating" integer not null, "customer_note" text null, "seller_note" text null, "status" text check ("status" in ('pending', 'published', 'rejected')) not null default 'pending', "created_at" timestamptz not null default now(), "updated_at" timestamptz not null default now(), "deleted_at" timestamptz null, constraint "review_pkey" primary key ("id"));`
+ )
+ this.addSql(
+ `alter table if exists "review" add column if not exists "display_id" serial;`
+ )
+ this.addSql(
+ `CREATE INDEX IF NOT EXISTS "IDX_review_deleted_at" ON "review" ("deleted_at") WHERE deleted_at IS NULL;`
+ )
+ }
+
+ override async down(): Promise<void> {
+ this.addSql(`drop table if exists "review" cascade;`)
+ }
+}
diff --git a/packages/core/src/modules/review/models/index.ts b/packages/core/src/modules/review/models/index.ts
new file mode 100644
index 000000000..0a9c85ce2
--- /dev/null
+++ b/packages/core/src/modules/review/models/index.ts
@@ -0,0 +1 @@
+export { default as Review } from "./review"
diff --git a/packages/core/src/modules/review/models/review.ts b/packages/core/src/modules/review/models/review.ts
new file mode 100644
index 000000000..443f69290
--- /dev/null
+++ b/packages/core/src/modules/review/models/review.ts
@@ -0,0 +1,13 @@
+import { model } from "@medusajs/framework/utils"
+
+const Review = model.define("review", {
+ id: model.id({ prefix: "rev" }).primaryKey(),
+ display_id: model.autoincrement(),
+ reference: model.enum(["product", "seller"]),
+ rating: model.number(),
+ customer_note: model.text().searchable().nullable(),
+ seller_note: model.text().searchable().nullable(),
+ status: model.enum(["pending", "published", "rejected"]).default("pending"),
+})
+
+export default Review
diff --git a/packages/core/src/modules/review/service.ts b/packages/core/src/modules/review/service.ts
new file mode 100644
index 000000000..720878e01
--- /dev/null
+++ b/packages/core/src/modules/review/service.ts
@@ -0,0 +1,77 @@
+import { InjectManager, MedusaService } from "@medusajs/framework/utils"
+import { Context } from "@medusajs/framework/types"
+import { EntityManager } from "@medusajs/framework/mikro-orm/knex"
+
+import { Review } from "./models"
+
+class ReviewModuleService extends MedusaService({
+ Review,
+}) {
+ @InjectManager()
+ async getAvgRating(
+ type: "seller" | "product",
+ id: string,
+ sharedContext?: Context<EntityManager>
+ ): Promise<string | null> {
+ const knex = sharedContext!.manager!.getKnex()
+
+ const joinField = type === "product" ? "product_id" : "seller_id"
+ const joinTable =
+ type === "product"
+ ? "product_product_review_review"
+ : "seller_seller_review_review"
+
+ const [result] = await knex("review")
+ .avg("review.rating")
+ .leftJoin(joinTable, `${joinTable}.review_id`, "review.id")
+ .where(`${joinTable}.${joinField}`, id)
+
+ return result?.avg ?? null
+ }
+
+ @InjectManager()
+ async getSellersWithRating(
+ fields: string[],
+ sharedContext?: Context<EntityManager>
+ ) {
+ const knex = sharedContext!.manager!.getKnex()
+
+ const result = await knex
+ .select(...fields.map((f) => `seller.${f}`))
+ .avg("review.rating as rating")
+ .from("seller")
+ .leftJoin(
+ "seller_seller_review_review",
+ "seller.id",
+ "seller_seller_review_review.seller_id"
+ )
+ .leftJoin("review", "review.id", "seller_seller_review_review.review_id")
+ .groupBy("seller.id")
+
+ return result
+ }
+
+ @InjectManager()
+ async getProductsWithRating(
+ fields: string[],
+ sharedContext?: Context<EntityManager>
+ ) {
+ const knex = sharedContext!.manager!.getKnex()
+
+ const result = await knex
+ .select(...fields.map((f) => `product.${f}`))
+ .avg("review.rating as rating")
+ .from("product")
+ .leftJoin(
+ "product_product_review_review",
+ "product.id",
+ "product_product_review_review.product_id"
+ )
+ .leftJoin("review", "review.id", "product_product_review_review.review_id")
+ .groupBy("product.id")
+
+ return result
+ }
+}
+
+export default ReviewModuleService
diff --git a/packages/core/src/workflows/index.ts b/packages/core/src/workflows/index.ts
index df7f4ffea..026817b02 100644
--- a/packages/core/src/workflows/index.ts
+++ b/packages/core/src/workflows/index.ts
@@ -20,3 +20,4 @@ export * from './product-edit'
export * from './offer'
export * from './media'
export * from './order'
+export * from './review'
diff --git a/packages/core/src/workflows/review/index.ts b/packages/core/src/workflows/review/index.ts
new file mode 100644
index 000000000..e84516860
--- /dev/null
+++ b/packages/core/src/workflows/review/index.ts
@@ -0,0 +1,2 @@
+export * from "./workflows"
+export * from "./steps"
diff --git a/packages/core/src/workflows/review/steps/create-review.ts b/packages/core/src/workflows/review/steps/create-review.ts
new file mode 100644
index 000000000..d3aa57c79
--- /dev/null
+++ b/packages/core/src/workflows/review/steps/create-review.ts
@@ -0,0 +1,49 @@
+import { ContainerRegistrationKeys, Modules } from "@medusajs/framework/utils"
+import { StepResponse, createStep } from "@medusajs/framework/workflows-sdk"
+import { Link } from "@medusajs/framework/modules-sdk"
+import { CreateReviewDTO } from "@mercurjs/types"
+
+import ReviewModuleService from "../../../modules/review/service"
+import { MercurModules } from "@mercurjs/types"
+
+export const createReviewStep = createStep(
+ "create-review",
+ async (input: CreateReviewDTO, { container }) => {
+ const service = container.resolve<ReviewModuleService>(MercurModules.REVIEW)
+ const link = container.resolve<Link>(ContainerRegistrationKeys.LINK)
+
+ const review = await service.createReviews({
+ reference: input.reference,
+ rating: input.rating,
+ customer_note: input.customer_note ?? null,
+ })
+
+ await link.create([
+ {
+ [Modules.CUSTOMER]: {
+ customer_id: input.customer_id,
+ },
+ [MercurModules.REVIEW]: {
+ review_id: review.id,
+ },
+ },
+ {
+ [Modules.ORDER]: {
+ order_id: input.order_id,
+ },
+ [MercurModules.REVIEW]: {
+ review_id: review.id,
+ },
+ },
+ ])
+
+ return new StepResponse(review, review.id)
+ },
+ async (reviewId: string | undefined, { container }) => {
+ if (!reviewId) {
+ return
+ }
+ const service = container.resolve<ReviewModuleService>(MercurModules.REVIEW)
+ await service.deleteReviews(reviewId)
+ }
+)
diff --git a/packages/core/src/workflows/review/steps/delete-review.ts b/packages/core/src/workflows/review/steps/delete-review.ts
new file mode 100644
index 000000000..8967fda80
--- /dev/null
+++ b/packages/core/src/workflows/review/steps/delete-review.ts
@@ -0,0 +1,22 @@
+import { StepResponse, createStep } from "@medusajs/framework/workflows-sdk"
+import { MercurModules } from "@mercurjs/types"
+
+import ReviewModuleService from "../../../modules/review/service"
+
+export const deleteReviewStep = createStep(
+ "delete-review",
+ async (id: string, { container }) => {
+ const service = container.resolve<ReviewModuleService>(MercurModules.REVIEW)
+
+ await service.softDeleteReviews(id)
+
+ return new StepResponse(id, id)
+ },
+ async (id: string | undefined, { container }) => {
+ if (!id) {
+ return
+ }
+ const service = container.resolve<ReviewModuleService>(MercurModules.REVIEW)
+ await service.restoreReviews(id)
+ }
+)
diff --git a/packages/core/src/workflows/review/steps/index.ts b/packages/core/src/workflows/review/steps/index.ts
new file mode 100644
index 000000000..02d899776
--- /dev/null
+++ b/packages/core/src/workflows/review/steps/index.ts
@@ -0,0 +1,5 @@
+export * from "./create-review"
+export * from "./update-review"
+export * from "./respond-review"
+export * from "./delete-review"
+export * from "./validate-review"
diff --git a/packages/core/src/workflows/review/steps/respond-review.ts b/packages/core/src/workflows/review/steps/respond-review.ts
new file mode 100644
index 000000000..2ea593245
--- /dev/null
+++ b/packages/core/src/workflows/review/steps/respond-review.ts
@@ -0,0 +1,39 @@
+import { MedusaError } from "@medusajs/framework/utils"
+import { StepResponse, createStep } from "@medusajs/framework/workflows-sdk"
+import { MercurModules, RespondReviewDTO } from "@mercurjs/types"
+
+import ReviewModuleService from "../../../modules/review/service"
+
+export const respondReviewStep = createStep(
+ "respond-review",
+ async (input: RespondReviewDTO, { container }) => {
+ const service = container.resolve<ReviewModuleService>(MercurModules.REVIEW)
+
+ const [review] = await service.listReviews({ id: input.id })
+
+ if (!review) {
+ throw new MedusaError(MedusaError.Types.NOT_FOUND, "Review not found")
+ }
+
+ if (review.seller_note) {
+ throw new MedusaError(
+ MedusaError.Types.NOT_ALLOWED,
+ "This review already has a response"
+ )
+ }
+
+ const updated = await service.updateReviews({
+ id: input.id,
+ seller_note: input.seller_note,
+ })
+
+ return new StepResponse(updated, input.id)
+ },
+ async (reviewId: string | undefined, { container }) => {
+ if (!reviewId) {
+ return
+ }
+ const service = container.resolve<ReviewModuleService>(MercurModules.REVIEW)
+ await service.updateReviews({ id: reviewId, seller_note: null })
+ }
+)
diff --git a/packages/core/src/workflows/review/steps/update-review.ts b/packages/core/src/workflows/review/steps/update-review.ts
new file mode 100644
index 000000000..764434e22
--- /dev/null
+++ b/packages/core/src/workflows/review/steps/update-review.ts
@@ -0,0 +1,30 @@
+import { StepResponse, createStep } from "@medusajs/framework/workflows-sdk"
+import { MercurModules, UpdateReviewDTO } from "@mercurjs/types"
+
+import ReviewModuleService from "../../../modules/review/service"
+
+export const updateReviewStep = createStep(
+ "update-review",
+ async (input: UpdateReviewDTO, { container }) => {
+ const service = container.resolve<ReviewModuleService>(MercurModules.REVIEW)
+
+ const [previous] = await service.listReviews({ id: input.id })
+
+ const review = await service.updateReviews(input)
+
+ return new StepResponse(review, previous)
+ },
+ async (previous, { container }) => {
+ if (!previous) {
+ return
+ }
+ const service = container.resolve<ReviewModuleService>(MercurModules.REVIEW)
+ await service.updateReviews({
+ id: previous.id,
+ rating: previous.rating,
+ customer_note: previous.customer_note,
+ seller_note: previous.seller_note,
+ status: previous.status,
+ })
+ }
+)
diff --git a/packages/registry/src/reviews/workflows/review/steps/validate-review.ts b/packages/core/src/workflows/review/steps/validate-review.ts
similarity index 73%
rename from packages/registry/src/reviews/workflows/review/steps/validate-review.ts
rename to packages/core/src/workflows/review/steps/validate-review.ts
index 83003bd32..8ddb517d7 100644
--- a/packages/registry/src/reviews/workflows/review/steps/validate-review.ts
+++ b/packages/core/src/workflows/review/steps/validate-review.ts
@@ -1,17 +1,17 @@
import {
ContainerRegistrationKeys,
MedusaError,
-} from "@medusajs/framework/utils";
-import { createStep } from "@medusajs/framework/workflows-sdk";
+} from "@medusajs/framework/utils"
+import { createStep } from "@medusajs/framework/workflows-sdk"
+import { Query } from "@medusajs/framework"
+import { CreateReviewDTO } from "@mercurjs/types"
-import { CreateReviewDTO } from "../../../modules/reviews";
-import orderReview from "../../../links/order-review";
-import { Query } from "@medusajs/framework";
+import orderReview from "../../../links/order-review"
export const validateReviewStep = createStep(
"validate-review",
async (reviewToCreate: CreateReviewDTO, { container }) => {
- const query = container.resolve<Query>(ContainerRegistrationKeys.QUERY);
+ const query = container.resolve<Query>(ContainerRegistrationKeys.QUERY)
const {
data: [order],
@@ -22,10 +22,10 @@ export const validateReviewStep = createStep(
id: reviewToCreate.order_id,
customer_id: reviewToCreate.customer_id,
},
- });
+ })
if (!order) {
- throw new MedusaError(MedusaError.Types.INVALID_DATA, "Order not found!");
+ throw new MedusaError(MedusaError.Types.INVALID_DATA, "Order not found!")
}
const { data } = await query.graph({
@@ -34,9 +34,9 @@ export const validateReviewStep = createStep(
filters: {
order_id: reviewToCreate.order_id,
},
- });
+ })
- const reviews = data.map((relation) => relation.review);
+ const reviews = data.map((relation) => relation.review)
if (
reviews.some(
@@ -48,7 +48,7 @@ export const validateReviewStep = createStep(
throw new MedusaError(
MedusaError.Types.INVALID_DATA,
"Review already exists"
- );
+ )
}
}
-);
+)
diff --git a/packages/core/src/workflows/review/workflows/create-review.ts b/packages/core/src/workflows/review/workflows/create-review.ts
new file mode 100644
index 000000000..97ae24439
--- /dev/null
+++ b/packages/core/src/workflows/review/workflows/create-review.ts
@@ -0,0 +1,48 @@
+import { Modules } from "@medusajs/framework/utils"
+import {
+ WorkflowResponse,
+ createWorkflow,
+ transform,
+} from "@medusajs/framework/workflows-sdk"
+import { createRemoteLinkStep } from "@medusajs/medusa/core-flows"
+import { CreateReviewDTO, MercurModules } from "@mercurjs/types"
+
+import { createReviewStep, validateReviewStep } from "../steps"
+
+export const createReviewWorkflow = createWorkflow(
+ {
+ name: "create-review",
+ },
+ function (input: CreateReviewDTO) {
+ validateReviewStep(input)
+ const review = createReviewStep(input)
+
+ const link = transform({ input, review }, ({ input, review }) => {
+ return input.reference === "product"
+ ? [
+ {
+ [Modules.PRODUCT]: {
+ product_id: input.reference_id,
+ },
+ [MercurModules.REVIEW]: {
+ review_id: review.id,
+ },
+ },
+ ]
+ : [
+ {
+ [MercurModules.SELLER]: {
+ seller_id: input.reference_id,
+ },
+ [MercurModules.REVIEW]: {
+ review_id: review.id,
+ },
+ },
+ ]
+ })
+
+ createRemoteLinkStep(link)
+
+ return new WorkflowResponse(review)
+ }
+)
diff --git a/packages/registry/src/reviews/workflows/review/workflows/delete-review.ts b/packages/core/src/workflows/review/workflows/delete-review.ts
similarity index 52%
rename from packages/registry/src/reviews/workflows/review/workflows/delete-review.ts
rename to packages/core/src/workflows/review/workflows/delete-review.ts
index 63e6bbe04..0b4adbc7e 100644
--- a/packages/registry/src/reviews/workflows/review/workflows/delete-review.ts
+++ b/packages/core/src/workflows/review/workflows/delete-review.ts
@@ -1,17 +1,17 @@
import {
WorkflowResponse,
createWorkflow,
-} from "@medusajs/framework/workflows-sdk";
+} from "@medusajs/framework/workflows-sdk"
-import { deleteReviewStep } from "../steps";
+import { deleteReviewStep } from "../steps"
export const deleteReviewWorkflow = createWorkflow(
{
name: "delete-review",
},
function (id: string) {
- deleteReviewStep(id);
+ deleteReviewStep(id)
- return new WorkflowResponse(id);
+ return new WorkflowResponse(id)
}
-);
+)
diff --git a/packages/core/src/workflows/review/workflows/index.ts b/packages/core/src/workflows/review/workflows/index.ts
new file mode 100644
index 000000000..d754383fb
--- /dev/null
+++ b/packages/core/src/workflows/review/workflows/index.ts
@@ -0,0 +1,4 @@
+export * from "./create-review"
+export * from "./update-review"
+export * from "./respond-review"
+export * from "./delete-review"
diff --git a/packages/core/src/workflows/review/workflows/respond-review.ts b/packages/core/src/workflows/review/workflows/respond-review.ts
new file mode 100644
index 000000000..a734cfab3
--- /dev/null
+++ b/packages/core/src/workflows/review/workflows/respond-review.ts
@@ -0,0 +1,18 @@
+import {
+ WorkflowResponse,
+ createWorkflow,
+} from "@medusajs/framework/workflows-sdk"
+import { RespondReviewDTO } from "@mercurjs/types"
+
+import { respondReviewStep } from "../steps"
+
+export const respondReviewWorkflow = createWorkflow(
+ {
+ name: "respond-review",
+ },
+ function (input: RespondReviewDTO) {
+ const review = respondReviewStep(input)
+
+ return new WorkflowResponse(review)
+ }
+)
diff --git a/packages/core/src/workflows/review/workflows/update-review.ts b/packages/core/src/workflows/review/workflows/update-review.ts
new file mode 100644
index 000000000..3a1e91aec
--- /dev/null
+++ b/packages/core/src/workflows/review/workflows/update-review.ts
@@ -0,0 +1,18 @@
+import {
+ WorkflowResponse,
+ createWorkflow,
+} from "@medusajs/framework/workflows-sdk"
+import { UpdateReviewDTO } from "@mercurjs/types"
+
+import { updateReviewStep } from "../steps"
+
+export const updateReviewWorkflow = createWorkflow(
+ {
+ name: "update-review",
+ },
+ function (input: UpdateReviewDTO) {
+ const review = updateReviewStep(input)
+
+ return new WorkflowResponse(review)
+ }
+)
diff --git a/packages/dashboard-shared/src/lib/query-key-factory.ts b/packages/dashboard-shared/src/lib/query-key-factory.ts
index c452a7d73..0c6d55477 100644
--- a/packages/dashboard-shared/src/lib/query-key-factory.ts
+++ b/packages/dashboard-shared/src/lib/query-key-factory.ts
@@ -36,20 +36,19 @@ export const queryKeysFactory = <
>(
globalKey: T
) => {
- const queryKeyFactory: TQueryKey<T, TListQueryType, TDetailQueryType> = {
+ type Keys = TQueryKey<T, TListQueryType, TDetailQueryType>
+ const queryKeyFactory: Keys = {
all: [globalKey],
lists: () => [...queryKeyFactory.all, "list"],
- // @ts-expect-error
list: (query?: TListQueryType) =>
[...queryKeyFactory.lists(), query ? { query } : undefined].filter(
(k) => !!k
- ),
+ ) as unknown as ReturnType<Keys["list"]>,
details: () => [...queryKeyFactory.all, "detail"],
- // @ts-expect-error
detail: (id: TDetailQueryType, query?: TListQueryType) =>
[...queryKeyFactory.details(), id, query ? { query } : undefined].filter(
(k) => !!k
- ),
+ ) as unknown as ReturnType<Keys["detail"]>,
}
return queryKeyFactory
}
diff --git a/packages/registry/r/registry.json b/packages/registry/r/registry.json
index 4fa24ef79..a0b3474af 100644
--- a/packages/registry/r/registry.json
+++ b/packages/registry/r/registry.json
@@ -3,222 +3,6 @@
"name": "@mercurjs",
"homepage": "https://mercurjs.com",
"items": [
- {
- "name": "reviews",
- "description": "A review system with product and seller reviews, ratings, customer/vendor/admin API routes, and workflows.",
- "dependencies": [],
- "registryDependencies": [],
- "docs": "## Configuration\n\nAdd the review module to your `medusa-config.ts`:\n\n```ts\nmodules: [\n {\n resolve: './modules/reviews',\n },\n]\n```\n\n## Middlewares\n\nAdd the review middlewares to your `api/middlewares.ts`:\n\n```ts\nimport { defineMiddlewares } from \"@medusajs/medusa\";\nimport { adminReviewsMiddlewares } from \"./admin/reviews/middlewares\";\nimport { vendorReviewsMiddlewares } from \"./vendor/reviews/middlewares\";\nimport { storeReviewMiddlewares } from \"./store/reviews/middlewares\";\n\nexport default defineMiddlewares({\n routes: [...adminReviewsMiddlewares, ...vendorReviewsMiddlewares, ...storeReviewMiddlewares],\n});\n```\n\nIf you already have a `middlewares.ts` file, merge the review middleware imports and spread them into your existing `routes` array.\n\n## Database Migrations\n\nAfter installing the block and adding the module configuration, generate and run the migrations to create the necessary tables in your database:\n\n```bash\nnpx medusa db:generate reviews\nnpx medusa db:migrate\n```",
- "files": [
- {
- "path": "reviews/modules/reviews/index.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/modules/reviews/service.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/modules/reviews/models/review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/modules/reviews/types/index.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/modules/reviews/types/common.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/modules/reviews/types/mutations.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/links/customer-review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/links/order-review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/links/product-review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/links/seller-review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/index.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/steps/index.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/steps/create-review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/steps/update-review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/steps/delete-review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/steps/validate-review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/workflows/index.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/workflows/create-review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/workflows/update-review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/workflows/delete-review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/admin/reviews/route.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/admin/reviews/middlewares.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/admin/reviews/query-config.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/admin/reviews/validators.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/admin/reviews/[id]/route.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/store/reviews/route.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/store/reviews/middlewares.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/store/reviews/helpers.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/store/reviews/query-config.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/store/reviews/validators.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/store/reviews/[id]/route.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/vendor/reviews/middlewares.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/vendor/reviews/helpers.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/vendor/reviews/query-config.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/vendor/reviews/validators.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/vendor/reviews/route.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/vendor/reviews/[id]/route.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/vendor/hooks/api/reviews.tsx",
- "type": "registry:vendor"
- },
- {
- "path": "reviews/vendor/hooks/table/columns/use-review-table-columns.tsx",
- "type": "registry:vendor"
- },
- {
- "path": "reviews/vendor/hooks/table/filters/use-review-table-filters.tsx",
- "type": "registry:vendor"
- },
- {
- "path": "reviews/vendor/hooks/table/query/use-review-table-query.tsx",
- "type": "registry:vendor"
- },
- {
- "path": "reviews/vendor/routes/reviews/page.tsx",
- "type": "registry:vendor"
- },
- {
- "path": "reviews/vendor/routes/reviews/[id]/page.tsx",
- "type": "registry:vendor"
- },
- {
- "path": "reviews/vendor/routes/reviews/[id]/breadcrumb.tsx",
- "type": "registry:vendor"
- },
- {
- "path": "reviews/admin/hooks/api/reviews.tsx",
- "type": "registry:admin"
- },
- {
- "path": "reviews/admin/hooks/table/columns/use-review-table-columns.tsx",
- "type": "registry:admin"
- },
- {
- "path": "reviews/admin/hooks/table/filters/use-review-table-filters.tsx",
- "type": "registry:admin"
- },
- {
- "path": "reviews/admin/hooks/table/query/use-review-table-query.tsx",
- "type": "registry:admin"
- },
- {
- "path": "reviews/admin/routes/reviews/page.tsx",
- "type": "registry:admin"
- },
- {
- "path": "reviews/admin/routes/reviews/[id]/page.tsx",
- "type": "registry:admin"
- },
- {
- "path": "reviews/admin/routes/reviews/[id]/breadcrumb.tsx",
- "type": "registry:admin"
- }
- ],
- "categories": [
- "reviews"
- ]
- },
{
"name": "product-import-export",
"description": "CSV product import & export for vendors. Includes API routes, workflows, and vendor portal drawers.",
diff --git a/packages/registry/r/reviews.json b/packages/registry/r/reviews.json
deleted file mode 100644
index 1f87fbfa8..000000000
--- a/packages/registry/r/reviews.json
+++ /dev/null
@@ -1,268 +0,0 @@
-{
- "$schema": "https://registry.mercurjs.com/registry-item.json",
- "name": "reviews",
- "description": "A review system with product and seller reviews, ratings, customer/vendor/admin API routes, and workflows.",
- "dependencies": [],
- "registryDependencies": [],
- "docs": "## Configuration\n\nAdd the review module to your `medusa-config.ts`:\n\n```ts\nmodules: [\n {\n resolve: './modules/reviews',\n },\n]\n```\n\n## Middlewares\n\nAdd the review middlewares to your `api/middlewares.ts`:\n\n```ts\nimport { defineMiddlewares } from \"@medusajs/medusa\";\nimport { adminReviewsMiddlewares } from \"./admin/reviews/middlewares\";\nimport { vendorReviewsMiddlewares } from \"./vendor/reviews/middlewares\";\nimport { storeReviewMiddlewares } from \"./store/reviews/middlewares\";\n\nexport default defineMiddlewares({\n routes: [...adminReviewsMiddlewares, ...vendorReviewsMiddlewares, ...storeReviewMiddlewares],\n});\n```\n\nIf you already have a `middlewares.ts` file, merge the review middleware imports and spread them into your existing `routes` array.\n\n## Database Migrations\n\nAfter installing the block and adding the module configuration, generate and run the migrations to create the necessary tables in your database:\n\n```bash\nnpx medusa db:generate reviews\nnpx medusa db:migrate\n```",
- "categories": [
- "reviews"
- ],
- "files": [
- {
- "path": "reviews/modules/reviews/index.ts",
- "content": "import { Module } from \"@medusajs/framework/utils\";\n\nimport ReviewModuleService from \"./service\";\n\nexport const REVIEW_MODULE = \"reviews\";\n\nexport * from \"./types\";\nexport { ReviewModuleService };\n\nexport default Module(REVIEW_MODULE, {\n service: ReviewModuleService,\n});\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/modules/reviews/service.ts",
- "content": "import {\n InjectManager,\n MedusaService,\n} from '@medusajs/framework/utils'\nimport { Context } from '@medusajs/framework/types'\nimport { EntityManager } from '@medusajs/framework/mikro-orm/knex'\n\nimport { Review } from './models/review'\n\nclass ReviewModuleService extends MedusaService({\n Review\n}) {\n @InjectManager()\n async getAvgRating(\n type: 'seller' | 'product',\n id: string,\n sharedContext?: Context<EntityManager>\n ): Promise<string | null> {\n const knex = sharedContext!.manager!.getKnex()\n\n const joinField = type === 'product' ? 'product_id' : 'seller_id'\n const joinTable =\n type === 'product'\n ? 'product_product_review_review'\n : 'seller_seller_review_review'\n\n const [result] = await knex('review')\n .avg('review.rating')\n .leftJoin(joinTable, `${joinTable}.review_id`, 'review.id')\n .where(`${joinTable}.${joinField}`, id)\n\n return result?.avg ?? null\n }\n\n @InjectManager()\n async getSellersWithRating(\n fields: string[],\n sharedContext?: Context<EntityManager>\n ) {\n const knex = sharedContext!.manager!.getKnex()\n\n const result = await knex\n .select(...fields.map((f) => `seller.${f}`))\n .avg('review.rating as rating')\n .from('seller')\n .leftJoin(\n 'seller_seller_review_review',\n 'seller.id',\n 'seller_seller_review_review.seller_id'\n )\n .leftJoin('review', 'review.id', 'seller_seller_review_review.review_id')\n .groupBy('seller.id')\n\n return result\n }\n\n @InjectManager()\n async getProductsWithRating(\n fields: string[],\n sharedContext?: Context<EntityManager>\n ) {\n const knex = sharedContext!.manager!.getKnex()\n\n const result = await knex\n .select(...fields.map((f) => `product.${f}`))\n .avg('review.rating as rating')\n .from('product')\n .leftJoin(\n 'product_product_review_review',\n 'product.id',\n 'product_product_review_review.product_id'\n )\n .leftJoin('review', 'review.id', 'product_product_review_review.review_id')\n .groupBy('product.id')\n\n return result\n }\n}\n\nexport default ReviewModuleService\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/modules/reviews/models/review.ts",
- "content": "import { model } from '@medusajs/framework/utils'\n\nexport const Review = model.define('review', {\n id: model.id({ prefix: 'rev' }).primaryKey(),\n reference: model.enum(['product', 'seller']),\n rating: model.number(),\n customer_note: model.text().nullable(),\n seller_note: model.text().nullable()\n})\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/modules/reviews/types/index.ts",
- "content": "export * from \"./common\"\nexport * from \"./mutations\"\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/modules/reviews/types/common.ts",
- "content": "import { DeleteResponse, PaginatedResponse } from \"@mercurjs/types\"\n\nexport type ReviewReference = \"product\" | \"seller\"\n\nexport interface ReviewDTO {\n id: string\n reference: ReviewReference\n rating: number\n customer_note: string | null\n seller_note: string | null\n created_at: Date | string\n updated_at: Date | string\n deleted_at: Date | string | null\n}\n\nexport interface AdminReviewResponse {\n review: ReviewDTO\n}\n\nexport type AdminReviewListResponse = PaginatedResponse<{\n reviews: ReviewDTO[]\n}>\n\nexport interface StoreReviewResponse {\n review: ReviewDTO\n}\n\nexport type StoreReviewListResponse = PaginatedResponse<{\n reviews: ReviewDTO[]\n}>\n\nexport type StoreReviewDeleteResponse = DeleteResponse<\"review\">\n\nexport interface VendorReviewResponse {\n review: ReviewDTO\n}\n\nexport type VendorReviewListResponse = PaginatedResponse<{\n reviews: ReviewDTO[]\n}>\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/modules/reviews/types/mutations.ts",
- "content": "import { ReviewReference } from \"./common\"\n\nexport interface CreateReviewDTO {\n reference: ReviewReference\n reference_id: string\n rating: number\n customer_note?: string | null\n customer_id: string\n order_id: string\n}\n\nexport interface UpdateReviewDTO {\n id: string\n rating?: number\n customer_note?: string | null\n seller_note?: string | null\n}\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/links/customer-review.ts",
- "content": "import { defineLink } from \"@medusajs/framework/utils\";\nimport CustomerModule from \"@medusajs/medusa/customer\";\n\nimport ReviewModule from \"../modules/reviews\";\n\nexport default defineLink(CustomerModule.linkable.customer, {\n linkable: ReviewModule.linkable.review,\n isList: true,\n});\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/links/order-review.ts",
- "content": "import { defineLink } from \"@medusajs/framework/utils\";\nimport OrderModule from \"@medusajs/medusa/order\";\n\nimport ReviewModule from \"../modules/reviews\";\n\nexport default defineLink(OrderModule.linkable.order, {\n linkable: ReviewModule.linkable.review,\n isList: true,\n});\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/links/product-review.ts",
- "content": "import { defineLink } from \"@medusajs/framework/utils\";\nimport ProductModule from \"@medusajs/medusa/product\";\n\nimport ReviewModule from \"../modules/reviews\";\n\nexport default defineLink(ProductModule.linkable.product, {\n linkable: ReviewModule.linkable.review,\n isList: true,\n});\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/links/seller-review.ts",
- "content": "import { defineLink } from \"@medusajs/framework/utils\";\n\nimport ReviewModule from \"../modules/reviews\";\nimport SellerModule from \"@mercurjs/core/modules/seller\";\n\nexport default defineLink(SellerModule.linkable.seller, {\n linkable: ReviewModule.linkable.review,\n isList: true,\n});\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/index.ts",
- "content": "export * from \"./workflows\";\nexport * from \"./steps\";\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/steps/index.ts",
- "content": "export * from './create-review'\nexport * from './update-review'\nexport * from './delete-review'\nexport * from './validate-review'\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/steps/create-review.ts",
- "content": "import { ContainerRegistrationKeys, Modules } from \"@medusajs/framework/utils\";\nimport { StepResponse, createStep } from \"@medusajs/framework/workflows-sdk\";\n\nimport { REVIEW_MODULE, ReviewModuleService, CreateReviewDTO } from \"../../../modules/reviews\";\nimport { Link } from \"@medusajs/framework/modules-sdk\";\n\nexport const createReviewStep = createStep(\n \"create-review\",\n async (input: CreateReviewDTO, { container }) => {\n const service = container.resolve<ReviewModuleService>(REVIEW_MODULE);\n const link = container.resolve<Link>(ContainerRegistrationKeys.LINK);\n\n const review = await service.createReviews(input);\n\n await link.create([\n {\n [Modules.CUSTOMER]: {\n customer_id: input.customer_id,\n },\n [REVIEW_MODULE]: {\n review_id: review.id,\n },\n },\n {\n [Modules.ORDER]: {\n order_id: input.order_id,\n },\n [REVIEW_MODULE]: {\n review_id: review.id,\n },\n },\n ]);\n return new StepResponse(review);\n }\n);\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/steps/update-review.ts",
- "content": "import { StepResponse, createStep } from \"@medusajs/framework/workflows-sdk\";\n\nimport { REVIEW_MODULE, ReviewModuleService, UpdateReviewDTO } from \"../../../modules/reviews\";\n\nexport const updateReviewStep = createStep(\n \"update-review\",\n async (input: UpdateReviewDTO, { container }) => {\n const service = container.resolve<ReviewModuleService>(REVIEW_MODULE);\n\n const review = await service.updateReviews(input);\n\n return new StepResponse(review);\n }\n);\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/steps/delete-review.ts",
- "content": "import { StepResponse, createStep } from \"@medusajs/framework/workflows-sdk\";\n\nimport { REVIEW_MODULE, ReviewModuleService } from \"../../../modules/reviews\";\n\nexport const deleteReviewStep = createStep(\n \"delete-review\",\n async (id: string, { container }) => {\n const service = container.resolve<ReviewModuleService>(REVIEW_MODULE);\n\n await service.softDeleteReviews(id);\n\n return new StepResponse(id);\n }\n);\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/steps/validate-review.ts",
- "content": "import {\n ContainerRegistrationKeys,\n MedusaError,\n} from \"@medusajs/framework/utils\";\nimport { createStep } from \"@medusajs/framework/workflows-sdk\";\n\nimport { CreateReviewDTO } from \"../../../modules/reviews\";\nimport orderReview from \"../../../links/order-review\";\nimport { Query } from \"@medusajs/framework\";\n\nexport const validateReviewStep = createStep(\n \"validate-review\",\n async (reviewToCreate: CreateReviewDTO, { container }) => {\n const query = container.resolve<Query>(ContainerRegistrationKeys.QUERY);\n\n const {\n data: [order],\n } = await query.graph({\n entity: \"order\",\n fields: [\"id\"],\n filters: {\n id: reviewToCreate.order_id,\n customer_id: reviewToCreate.customer_id,\n },\n });\n\n if (!order) {\n throw new MedusaError(MedusaError.Types.INVALID_DATA, \"Order not found!\");\n }\n\n const { data } = await query.graph({\n entity: orderReview.entryPoint,\n fields: [\"review.reference\", \"review.product.id\", \"review.seller.id\"],\n filters: {\n order_id: reviewToCreate.order_id,\n },\n });\n\n const reviews = data.map((relation) => relation.review);\n\n if (\n reviews.some(\n (rev) =>\n rev.reference === reviewToCreate.reference &&\n rev[rev.reference].id === reviewToCreate.reference_id\n )\n ) {\n throw new MedusaError(\n MedusaError.Types.INVALID_DATA,\n \"Review already exists\"\n );\n }\n }\n);\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/workflows/index.ts",
- "content": "export * from './create-review'\nexport * from './delete-review'\nexport * from './update-review'\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/workflows/create-review.ts",
- "content": "import { Modules } from \"@medusajs/framework/utils\";\nimport {\n WorkflowResponse,\n createWorkflow,\n transform,\n} from \"@medusajs/framework/workflows-sdk\";\nimport {\n createRemoteLinkStep,\n} from \"@medusajs/medusa/core-flows\";\n\nimport { CreateReviewDTO, REVIEW_MODULE } from \"../../../modules/reviews\";\nconst SELLER_MODULE = \"seller\";\n\nimport { createReviewStep, validateReviewStep } from \"../steps\";\n\nexport const createReviewWorkflow = createWorkflow(\n {\n name: \"create-review\",\n },\n function (input: CreateReviewDTO) {\n validateReviewStep(input);\n const review = createReviewStep(input);\n\n const link = transform({ input, review }, ({ input, review }) => {\n return input.reference === \"product\"\n ? [\n {\n [Modules.PRODUCT]: {\n product_id: input.reference_id,\n },\n [REVIEW_MODULE]: {\n review_id: review.id,\n },\n },\n ]\n : [\n {\n [SELLER_MODULE]: {\n seller_id: input.reference_id,\n },\n [REVIEW_MODULE]: {\n review_id: review.id,\n },\n },\n ];\n });\n\n createRemoteLinkStep(link);\n\n return new WorkflowResponse(review);\n }\n);\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/workflows/update-review.ts",
- "content": "import {\n WorkflowResponse,\n createWorkflow,\n} from \"@medusajs/framework/workflows-sdk\";\n\nimport { UpdateReviewDTO } from \"../../../modules/reviews\";\nimport { updateReviewStep } from \"../steps\";\n\nexport const updateReviewWorkflow = createWorkflow(\n {\n name: \"update-review\",\n },\n function (input: UpdateReviewDTO) {\n const review = updateReviewStep(input);\n\n return new WorkflowResponse(review);\n }\n);\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/workflows/delete-review.ts",
- "content": "import {\n WorkflowResponse,\n createWorkflow,\n} from \"@medusajs/framework/workflows-sdk\";\n\nimport { deleteReviewStep } from \"../steps\";\n\nexport const deleteReviewWorkflow = createWorkflow(\n {\n name: \"delete-review\",\n },\n function (id: string) {\n deleteReviewStep(id);\n\n return new WorkflowResponse(id);\n }\n);\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/admin/reviews/route.ts",
- "content": "import { MedusaRequest, MedusaResponse } from '@medusajs/framework'\nimport { ContainerRegistrationKeys } from '@medusajs/framework/utils'\n\nimport { AdminReviewListResponse } from '../../../modules/reviews/types'\n\nexport async function GET(\n req: MedusaRequest,\n res: MedusaResponse<AdminReviewListResponse>\n): Promise<void> {\n const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)\n const { data: reviews, metadata } = await query.graph({\n entity: 'review',\n fields: req.queryConfig.fields,\n filters: req.filterableFields,\n pagination: req.queryConfig.pagination\n })\n\n res.json({\n reviews,\n count: metadata?.count ?? 0,\n offset: metadata?.skip ?? 0,\n limit: metadata?.take ?? 0\n })\n}\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/admin/reviews/middlewares.ts",
- "content": "import { validateAndTransformQuery } from \"@medusajs/framework\";\nimport { MiddlewareRoute } from \"@medusajs/medusa\";\n\nimport { adminReviewsConfig } from \"./query-config\";\nimport { AdminGetReviewsParams } from \"./validators\";\n\nexport const adminReviewsMiddlewares: MiddlewareRoute[] = [\n {\n method: [\"GET\"],\n matcher: \"/admin/reviews\",\n middlewares: [\n validateAndTransformQuery(AdminGetReviewsParams, adminReviewsConfig.list),\n ],\n },\n {\n method: [\"GET\"],\n matcher: \"/admin/reviews/:id\",\n middlewares: [\n validateAndTransformQuery(\n AdminGetReviewsParams,\n adminReviewsConfig.retrieve\n ),\n ],\n },\n];\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/admin/reviews/query-config.ts",
- "content": "export const adminReviewsFields = [\n 'id',\n 'reference',\n 'rating',\n 'customer_note',\n 'seller_note',\n 'created_at',\n 'updated_at'\n]\n\nexport const adminReviewsConfig = {\n list: {\n defaults: adminReviewsFields,\n isList: true\n },\n retrieve: {\n defaults: adminReviewsFields,\n isList: false\n }\n}\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/admin/reviews/validators.ts",
- "content": "import { z } from 'zod'\n\nimport { createFindParams } from '@medusajs/medusa/api/utils/validators'\n\nexport type AdminGetReviewsParamsType = z.infer<typeof AdminGetReviewsParams>\nexport const AdminGetReviewsParams = createFindParams({\n offset: 0,\n limit: 50\n}).extend({\n reference: z.enum(['product', 'seller']).optional()\n})\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/admin/reviews/[id]/route.ts",
- "content": "import { AuthenticatedMedusaRequest, MedusaResponse } from '@medusajs/framework'\nimport { ContainerRegistrationKeys } from '@medusajs/framework/utils'\n\nimport { AdminReviewResponse } from '../../../../modules/reviews/types'\n\nexport async function GET(\n req: AuthenticatedMedusaRequest,\n res: MedusaResponse<AdminReviewResponse>\n): Promise<void> {\n const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)\n\n const {\n data: [review]\n } = await query.graph({\n entity: 'review',\n fields: req.queryConfig.fields,\n filters: {\n id: req.params.id\n }\n })\n\n res.json({ review })\n}\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/store/reviews/route.ts",
- "content": "import {\n AuthenticatedMedusaRequest,\n MedusaResponse,\n} from \"@medusajs/framework\";\nimport { ContainerRegistrationKeys } from \"@medusajs/framework/utils\";\n\nimport customerReview from \"../../../links/customer-review\";\nimport { StoreReviewListResponse, StoreReviewResponse } from \"../../../modules/reviews/types\";\nimport { createReviewWorkflow } from \"../../../workflows/review/workflows\";\nimport { StoreCreateReviewType, StoreGetReviewsParamsType } from \"./validators\";\n\nexport const POST = async (\n req: AuthenticatedMedusaRequest<StoreCreateReviewType>,\n res: MedusaResponse<StoreReviewResponse>\n) => {\n const { result } = await createReviewWorkflow.run({\n container: req.scope,\n input: {\n ...req.validatedBody,\n customer_id: req.auth_context.actor_id,\n },\n });\n\n const query = req.scope.resolve(ContainerRegistrationKeys.QUERY);\n\n const {\n data: [review],\n } = await query.graph({\n entity: \"review\",\n fields: req.queryConfig.fields,\n filters: {\n id: result.id,\n },\n });\n\n res.status(201).json({ review });\n};\n\nexport const GET = async (\n req: AuthenticatedMedusaRequest<StoreGetReviewsParamsType>,\n res: MedusaResponse<StoreReviewListResponse>\n) => {\n const query = req.scope.resolve(ContainerRegistrationKeys.QUERY);\n\n const { data: reviews, metadata } = await query.graph({\n entity: customerReview.entryPoint,\n fields: req.queryConfig.fields.map((field) => `review.${field}`),\n filters: {\n customer_id: req.auth_context.actor_id,\n },\n pagination: req.queryConfig.pagination,\n });\n\n res.json({\n reviews: reviews.map((relation) => relation.review),\n count: metadata?.count ?? 0,\n offset: metadata?.skip ?? 0,\n limit: metadata?.take ?? 0,\n });\n};\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/store/reviews/middlewares.ts",
- "content": "import {\n authenticate,\n validateAndTransformBody,\n validateAndTransformQuery,\n} from \"@medusajs/framework\";\nimport { MiddlewareRoute } from \"@medusajs/medusa\";\n\nimport { storeReviewQueryConfig } from \"./query-config\";\nimport {\n StoreCreateReview,\n StoreGetReviewsParams,\n StoreUpdateReview,\n} from \"./validators\";\n\nexport const storeReviewMiddlewares: MiddlewareRoute[] = [\n {\n method: [\"GET\"],\n matcher: \"/store/reviews\",\n middlewares: [\n authenticate(\"customer\", [\"session\", \"bearer\"]),\n validateAndTransformQuery(\n StoreGetReviewsParams,\n storeReviewQueryConfig.list\n ),\n ],\n },\n {\n method: [\"POST\"],\n matcher: \"/store/reviews\",\n middlewares: [\n authenticate(\"customer\", [\"session\", \"bearer\"]),\n validateAndTransformQuery(\n StoreGetReviewsParams,\n storeReviewQueryConfig.retrieve\n ),\n validateAndTransformBody(StoreCreateReview),\n ],\n },\n {\n method: [\"GET\"],\n matcher: \"/store/reviews/:id\",\n middlewares: [\n authenticate(\"customer\", [\"session\", \"bearer\"]),\n validateAndTransformQuery(\n StoreGetReviewsParams,\n storeReviewQueryConfig.retrieve\n ),\n ],\n },\n {\n method: [\"DELETE\"],\n matcher: \"/store/reviews/:id\",\n middlewares: [\n authenticate(\"customer\", [\"session\", \"bearer\"]),\n ],\n },\n {\n method: [\"POST\"],\n matcher: \"/store/reviews/:id\",\n middlewares: [\n authenticate(\"customer\", [\"session\", \"bearer\"]),\n validateAndTransformQuery(\n StoreGetReviewsParams,\n storeReviewQueryConfig.retrieve\n ),\n validateAndTransformBody(StoreUpdateReview),\n ],\n },\n];\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/store/reviews/helpers.ts",
- "content": "import { MedusaContainer } from \"@medusajs/framework\"\nimport {\n ContainerRegistrationKeys,\n MedusaError,\n} from \"@medusajs/framework/utils\"\n\nimport customerReview from \"../../../links/customer-review\"\n\nexport const validateCustomerReview = async (\n scope: MedusaContainer,\n customerId: string,\n reviewId: string\n) => {\n const query = scope.resolve(ContainerRegistrationKeys.QUERY)\n\n const {\n data: [customerReviewLink],\n } = await query.graph({\n entity: customerReview.entryPoint,\n filters: {\n customer_id: customerId,\n review_id: reviewId,\n },\n fields: [\"customer_id\", \"review_id\"],\n })\n\n if (!customerReviewLink) {\n throw new MedusaError(\n MedusaError.Types.NOT_FOUND,\n `Review with id: ${reviewId} was not found`\n )\n }\n}\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/store/reviews/query-config.ts",
- "content": "export const storeReviewFields = [\n 'id',\n 'reference',\n 'rating',\n 'customer_note',\n 'customer.first_name',\n 'customer.last_name',\n 'seller_note',\n 'created_at',\n 'updated_at'\n]\n\nexport const storeReviewQueryConfig = {\n list: {\n defaults: storeReviewFields,\n isList: true\n },\n retrieve: {\n defaults: storeReviewFields,\n isList: false\n }\n}\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/store/reviews/validators.ts",
- "content": "import { z } from 'zod'\n\nimport { createFindParams } from '@medusajs/medusa/api/utils/validators'\n\nexport type StoreGetReviewsParamsType = z.infer<typeof StoreGetReviewsParams>\nexport const StoreGetReviewsParams = createFindParams({\n offset: 0,\n limit: 50\n})\n\nexport type StoreCreateReviewType = z.infer<typeof StoreCreateReview>\nexport const StoreCreateReview = z.object({\n order_id: z.string(),\n reference: z.enum(['seller', 'product']),\n reference_id: z.string(),\n rating: z.number().int().min(1).max(5),\n customer_note: z.string().max(300).nullable()\n})\n\nexport type StoreUpdateReviewType = z.infer<typeof StoreUpdateReview>\nexport const StoreUpdateReview = z.object({\n rating: z.number().int().min(1).max(5),\n customer_note: z.string().max(300).nullable()\n})\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/store/reviews/[id]/route.ts",
- "content": "import { AuthenticatedMedusaRequest, MedusaResponse } from '@medusajs/framework'\nimport { ContainerRegistrationKeys } from '@medusajs/framework/utils'\n\nimport { StoreReviewDeleteResponse, StoreReviewResponse } from '../../../../modules/reviews/types'\nimport {\n deleteReviewWorkflow,\n updateReviewWorkflow\n} from '../../../../workflows/review/workflows'\nimport { validateCustomerReview } from '../helpers'\nimport { StoreGetReviewsParamsType, StoreUpdateReviewType } from '../validators'\n\nexport const POST = async (\n req: AuthenticatedMedusaRequest<StoreUpdateReviewType>,\n res: MedusaResponse<StoreReviewResponse>\n) => {\n const { id } = req.params\n\n await validateCustomerReview(req.scope, req.auth_context.actor_id, id!)\n\n const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)\n\n await updateReviewWorkflow.run({\n container: req.scope,\n input: { id, ...req.validatedBody }\n })\n\n const {\n data: [review]\n } = await query.graph({\n entity: 'review',\n fields: req.queryConfig.fields,\n filters: {\n id\n }\n })\n\n res.json({\n review\n })\n}\n\nexport const DELETE = async (\n req: AuthenticatedMedusaRequest,\n res: MedusaResponse<StoreReviewDeleteResponse>\n) => {\n const { id } = req.params\n\n await validateCustomerReview(req.scope, req.auth_context.actor_id, id!)\n\n await deleteReviewWorkflow.run({\n container: req.scope,\n input: id\n })\n\n res.json({\n id: id!,\n object: 'review',\n deleted: true\n })\n}\n\nexport const GET = async (\n req: AuthenticatedMedusaRequest<StoreGetReviewsParamsType>,\n res: MedusaResponse<StoreReviewResponse>\n) => {\n const { id } = req.params\n\n await validateCustomerReview(req.scope, req.auth_context.actor_id, id!)\n\n const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)\n\n const {\n data: [review]\n } = await query.graph({\n entity: 'review',\n fields: req.queryConfig.fields,\n filters: {\n id\n }\n })\n\n res.json({\n review\n })\n}\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/vendor/reviews/middlewares.ts",
- "content": "import {\n AuthenticatedMedusaRequest,\n maybeApplyLinkFilter,\n MedusaNextFunction,\n MedusaResponse,\n MiddlewareRoute,\n} from \"@medusajs/framework/http\";\nimport {\n validateAndTransformBody,\n validateAndTransformQuery,\n} from \"@medusajs/framework\";\n\nimport sellerReview from \"../../../links/seller-review\";\nimport { vendorReviewQueryConfig } from \"./query-config\";\nimport { VendorGetReviewsParams, VendorUpdateReview } from \"./validators\";\n\nconst applySellerReviewLinkFilter = (\n req: AuthenticatedMedusaRequest,\n res: MedusaResponse,\n next: MedusaNextFunction\n) => {\n req.filterableFields.seller_id = req.auth_context.actor_id;\n\n return maybeApplyLinkFilter({\n entryPoint: sellerReview.entryPoint,\n resourceId: \"review_id\",\n filterableField: \"seller_id\",\n })(req, res, next);\n};\n\nexport const vendorReviewsMiddlewares: MiddlewareRoute[] = [\n {\n method: [\"GET\"],\n matcher: \"/vendor/reviews\",\n middlewares: [\n validateAndTransformQuery(\n VendorGetReviewsParams,\n vendorReviewQueryConfig.list\n ),\n applySellerReviewLinkFilter,\n ],\n },\n {\n method: [\"GET\"],\n matcher: \"/vendor/reviews/:id\",\n middlewares: [\n validateAndTransformQuery(\n VendorGetReviewsParams,\n vendorReviewQueryConfig.retrieve\n ),\n ],\n },\n {\n method: [\"POST\"],\n matcher: \"/vendor/reviews/:id\",\n middlewares: [\n validateAndTransformQuery(\n VendorGetReviewsParams,\n vendorReviewQueryConfig.retrieve\n ),\n validateAndTransformBody(VendorUpdateReview),\n ],\n },\n];\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/vendor/reviews/helpers.ts",
- "content": "import { MedusaContainer } from \"@medusajs/framework\"\nimport {\n ContainerRegistrationKeys,\n MedusaError,\n} from \"@medusajs/framework/utils\"\n\nimport sellerReview from \"../../../links/seller-review\"\n\nexport const validateSellerReview = async (\n scope: MedusaContainer,\n sellerId: string,\n reviewId: string\n) => {\n const query = scope.resolve(ContainerRegistrationKeys.QUERY)\n\n const {\n data: [sellerReviewLink],\n } = await query.graph({\n entity: sellerReview.entryPoint,\n filters: {\n seller_id: sellerId,\n review_id: reviewId,\n },\n fields: [\"seller_id\", \"review_id\"],\n })\n\n if (!sellerReviewLink) {\n throw new MedusaError(\n MedusaError.Types.NOT_FOUND,\n `Review with id: ${reviewId} was not found`\n )\n }\n}\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/vendor/reviews/query-config.ts",
- "content": "export const vendorReviewFields = [\n \"id\",\n \"rating\",\n \"customer_note\",\n \"customer_id\",\n \"seller_note\",\n \"created_at\",\n \"updated_at\",\n];\n\nexport const vendorReviewQueryConfig = {\n list: {\n defaults: vendorReviewFields,\n isList: true,\n },\n retrieve: {\n defaults: vendorReviewFields,\n isList: false,\n },\n};\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/vendor/reviews/validators.ts",
- "content": "import { z } from \"zod\";\nimport { createFindParams } from \"@medusajs/medusa/api/utils/validators\";\n\nexport type VendorGetReviewsParamsType = z.infer<typeof VendorGetReviewsParams>;\nexport const VendorGetReviewsParams = createFindParams({\n offset: 0,\n limit: 50,\n});\n\nexport type VendorUpdateReviewType = z.infer<typeof VendorUpdateReview>;\nexport const VendorUpdateReview = z.object({\n seller_note: z.string().max(300),\n});\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/vendor/reviews/route.ts",
- "content": "import { AuthenticatedMedusaRequest, MedusaResponse } from '@medusajs/framework'\nimport { ContainerRegistrationKeys } from '@medusajs/framework/utils'\n\nimport sellerReview from '../../../links/seller-review'\nimport { VendorReviewListResponse } from '../../../modules/reviews/types'\n\nexport const GET = async (\n req: AuthenticatedMedusaRequest,\n res: MedusaResponse<VendorReviewListResponse>\n) => {\n const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)\n\n const { data: reviews, metadata } = await query.graph({\n entity: sellerReview.entryPoint,\n fields: req.queryConfig.fields.map((field) => `review.${field}`),\n filters: req.filterableFields,\n pagination: req.queryConfig.pagination\n })\n\n res.json({\n reviews: reviews.map((relation) => relation.review),\n count: metadata?.count ?? 0,\n offset: metadata?.skip ?? 0,\n limit: metadata?.take ?? 0\n })\n}\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/vendor/reviews/[id]/route.ts",
- "content": "import { AuthenticatedMedusaRequest, MedusaResponse } from '@medusajs/framework'\nimport { ContainerRegistrationKeys } from '@medusajs/framework/utils'\n\nimport { VendorReviewResponse } from '../../../../modules/reviews/types'\nimport { updateReviewWorkflow } from '../../../../workflows/review/workflows'\nimport { validateSellerReview } from '../helpers'\nimport { VendorUpdateReviewType } from '../validators'\n\nexport const GET = async (\n req: AuthenticatedMedusaRequest,\n res: MedusaResponse<VendorReviewResponse>\n) => {\n const { id } = req.params\n\n await validateSellerReview(req.scope, req.auth_context.actor_id, id!)\n\n const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)\n\n const {\n data: [review]\n } = await query.graph({\n entity: 'review',\n fields: req.queryConfig.fields,\n filters: {\n id\n }\n })\n\n res.json({\n review\n })\n}\n\nexport const POST = async (\n req: AuthenticatedMedusaRequest<VendorUpdateReviewType>,\n res: MedusaResponse<VendorReviewResponse>\n) => {\n const { id } = req.params\n\n await validateSellerReview(req.scope, req.auth_context.actor_id, id!)\n\n const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)\n\n await updateReviewWorkflow.run({\n container: req.scope,\n input: { id, ...req.validatedBody }\n })\n\n const {\n data: [review]\n } = await query.graph({\n entity: 'review',\n fields: req.queryConfig.fields,\n filters: {\n id\n }\n })\n\n res.json({\n review\n })\n}\n",
- "type": "registry:api"
- },
- {
- "path": "reviews/vendor/hooks/api/reviews.tsx",
- "content": "import { useQuery, UseQueryOptions } from \"@tanstack/react-query\";\nimport { queryKeysFactory } from \"@mercurjs/dashboard-shared\";\nimport { client } from \"../../lib/client\";\nimport {\n ClientError,\n InferClientInput,\n InferClientOutput,\n} from \"@mercurjs/client\";\n\nconst REVIEWS_QUERY_KEY = \"vendor_reviews\" as const;\nexport const reviewsQueryKeys = queryKeysFactory(REVIEWS_QUERY_KEY);\n\nexport type ReviewDTO = InferClientOutput<\n typeof client.vendor.reviews.$id.query\n>[\"review\"];\n\nexport const useReviews = (\n query?: InferClientInput<typeof client.vendor.reviews.query>,\n options?: Omit<\n UseQueryOptions<\n unknown,\n ClientError,\n InferClientOutput<typeof client.vendor.reviews.query>\n >,\n \"queryKey\" | \"queryFn\"\n >,\n) => {\n const { data, ...rest } = useQuery({\n queryKey: reviewsQueryKeys.list(query),\n queryFn: async () =>\n client.vendor.reviews.query({\n ...query,\n }),\n ...options,\n });\n\n return { ...data, ...rest };\n};\n\nexport const useReview = (\n id: string,\n query?: InferClientInput<typeof client.vendor.reviews.$id.query>,\n options?: Omit<\n UseQueryOptions<\n unknown,\n ClientError,\n InferClientOutput<typeof client.vendor.reviews.$id.query>\n >,\n \"queryKey\" | \"queryFn\"\n >,\n) => {\n const { data, ...rest } = useQuery({\n queryKey: reviewsQueryKeys.detail(id, query),\n queryFn: async () =>\n client.vendor.reviews.$id.query({\n $id: id,\n ...query,\n }),\n ...options,\n });\n\n return { ...data, ...rest };\n};\n",
- "type": "registry:vendor"
- },
- {
- "path": "reviews/vendor/hooks/table/columns/use-review-table-columns.tsx",
- "content": "import { createColumnHelper } from \"@tanstack/react-table\";\nimport { useMemo } from \"react\";\nimport { StatusBadge, Text } from \"@medusajs/ui\";\nimport { DateCell, DateHeader } from \"@mercurjs/dashboard-shared\";\nimport { ReviewDTO } from \"../../api/reviews\";\n\nconst columnHelper = createColumnHelper<ReviewDTO>();\n\nconst ratingColor = (rating: number) => {\n if (rating >= 4) return \"green\" as const;\n if (rating >= 3) return \"orange\" as const;\n return \"red\" as const;\n};\n\nexport const useReviewTableColumns = () => {\n return useMemo(\n () => [\n columnHelper.accessor(\"rating\", {\n header: () => (\n <div className=\"flex h-full w-full items-center\">\n <span className=\"truncate\">Rating</span>\n </div>\n ),\n cell: ({ getValue }) => {\n const rating = getValue();\n return (\n <StatusBadge color={ratingColor(rating)}>{rating} / 5</StatusBadge>\n );\n },\n }),\n columnHelper.accessor(\"reference\", {\n header: () => (\n <div className=\"flex h-full w-full items-center\">\n <span className=\"truncate\">Reference</span>\n </div>\n ),\n cell: ({ getValue }) => {\n const reference = getValue();\n return (\n <Text size=\"small\" leading=\"compact\" className=\"text-ui-fg-subtle\">\n {reference.charAt(0).toUpperCase() + reference.slice(1)}\n </Text>\n );\n },\n }),\n columnHelper.accessor(\"customer_note\", {\n header: () => (\n <div className=\"flex h-full w-full items-center\">\n <span className=\"truncate\">Customer Note</span>\n </div>\n ),\n cell: ({ getValue }) => {\n const note = getValue();\n return (\n <div className=\"flex h-full w-full items-center overflow-hidden\">\n <Text\n size=\"small\"\n leading=\"compact\"\n className=\"text-ui-fg-subtle truncate\"\n >\n {note || \"-\"}\n </Text>\n </div>\n );\n },\n }),\n columnHelper.accessor(\"created_at\", {\n header: () => <DateHeader />,\n cell: ({ getValue }) => {\n const date = new Date(getValue());\n return <DateCell date={date} />;\n },\n }),\n ],\n [],\n );\n};\n",
- "type": "registry:vendor"
- },
- {
- "path": "reviews/vendor/hooks/table/filters/use-review-table-filters.tsx",
- "content": "import { useTranslation } from \"react-i18next\";\nimport { useMemo } from \"react\";\n\nimport type { Filter } from \"@mercurjs/dashboard-shared\";\n\nexport const useReviewTableFilters = (): Filter[] => {\n const { t } = useTranslation();\n\n return useMemo(() => {\n const filters: Filter[] = [];\n\n const dateFilters: Filter[] = [\n { label: t(\"fields.createdAt\"), key: \"created_at\" },\n { label: t(\"fields.updatedAt\"), key: \"updated_at\" },\n ].map((f) => ({\n key: f.key,\n label: f.label,\n type: \"date\",\n }));\n\n filters.push(...dateFilters);\n\n return filters;\n }, [t]);\n};\n",
- "type": "registry:vendor"
- },
- {
- "path": "reviews/vendor/hooks/table/query/use-review-table-query.tsx",
- "content": "import { useQueryParams } from \"@mercurjs/dashboard-shared\";\n\ntype UseReviewTableQueryProps = {\n prefix?: string;\n pageSize?: number;\n};\n\nexport const useReviewTableQuery = ({\n prefix,\n pageSize = 20,\n}: UseReviewTableQueryProps) => {\n const queryObject = useQueryParams(\n [\"offset\", \"q\", \"created_at\", \"updated_at\", \"order\"],\n prefix,\n );\n\n const { offset, created_at, updated_at, q, order } = queryObject;\n\n const searchParams: Record<string, any> = {\n limit: pageSize,\n offset: offset ? Number(offset) : 0,\n created_at: created_at ? JSON.parse(created_at) : undefined,\n updated_at: updated_at ? JSON.parse(updated_at) : undefined,\n order: order ? order : \"-created_at\",\n q,\n };\n\n return {\n searchParams,\n raw: queryObject,\n };\n};\n",
- "type": "registry:vendor"
- },
- {
- "path": "reviews/vendor/routes/reviews/page.tsx",
- "content": "import { useTranslation } from \"react-i18next\";\nimport { keepPreviousData } from \"@tanstack/react-query\";\nimport { Container, Heading } from \"@medusajs/ui\";\nimport { Star } from \"@medusajs/icons\";\nimport type { RouteConfig } from \"@mercurjs/dashboard-sdk\";\n\nimport { _DataTable, SingleColumnPage, useDataTable } from \"@mercurjs/dashboard-shared\";\nimport { useReviews } from \"../../hooks/api/reviews\";\nimport { useReviewTableColumns } from \"../../hooks/table/columns/use-review-table-columns\";\nimport { useReviewTableQuery } from \"../../hooks/table/query/use-review-table-query\";\nimport { useReviewTableFilters } from \"../../hooks/table/filters/use-review-table-filters\";\n\nconst PAGE_SIZE = 10;\n\nconst ReviewListPage = () => {\n const { t } = useTranslation();\n const { raw, searchParams } = useReviewTableQuery({\n pageSize: PAGE_SIZE,\n });\n\n const { reviews, count, isError, error, isLoading } = useReviews(\n searchParams,\n {\n placeholderData: keepPreviousData,\n },\n );\n\n const columns = useReviewTableColumns();\n const filters = useReviewTableFilters();\n\n const { table } = useDataTable({\n data: reviews ?? [],\n columns,\n enablePagination: true,\n count: count,\n pageSize: PAGE_SIZE,\n });\n\n if (isError) {\n throw error;\n }\n\n return (\n <SingleColumnPage>\n <Container className=\"divide-y p-0\">\n <div className=\"flex items-center justify-between px-6 py-4\">\n <Heading>Reviews</Heading>\n </div>\n <_DataTable\n columns={columns}\n table={table}\n pagination\n filters={filters}\n navigateTo={(row) => `/reviews/${row.original.id}`}\n count={count}\n isLoading={isLoading}\n pageSize={PAGE_SIZE}\n orderBy={[\n {\n key: \"created_at\",\n label: t(\"fields.createdAt\"),\n },\n {\n key: \"updated_at\",\n label: t(\"fields.updatedAt\"),\n },\n ]}\n queryObject={raw}\n noRecords={{\n message: \"No reviews found\",\n }}\n />\n </Container>\n </SingleColumnPage>\n );\n};\n\nexport default ReviewListPage;\n\nexport const config: RouteConfig = {\n label: \"Reviews\",\n icon: Star,\n};\n",
- "type": "registry:vendor"
- },
- {
- "path": "reviews/vendor/routes/reviews/[id]/page.tsx",
- "content": "import { useParams } from \"react-router-dom\";\nimport { Container, Heading, StatusBadge, Text } from \"@medusajs/ui\";\n\nimport {\n SingleColumnPageSkeleton,\n SingleColumnPage,\n} from \"@mercurjs/dashboard-shared\";\nimport { useReview, ReviewDTO } from \"../../../hooks/api/reviews\";\n\nconst ratingColor = (rating: number) => {\n if (rating >= 4) return \"green\" as const;\n if (rating >= 3) return \"orange\" as const;\n return \"red\" as const;\n};\n\nconst ReviewGeneralSection = ({ review }: { review: ReviewDTO }) => {\n return (\n <Container className=\"divide-y p-0\">\n <div className=\"flex items-center justify-between px-6 py-4\">\n <Heading>{review.id}</Heading>\n <div className=\"flex items-center gap-x-2\">\n <StatusBadge color={ratingColor(review.rating)}>\n {review.rating} / 5\n </StatusBadge>\n </div>\n </div>\n <div className=\"text-ui-fg-subtle grid grid-cols-2 items-center px-6 py-4\">\n <Text size=\"small\" leading=\"compact\" weight=\"plus\">\n Reference\n </Text>\n <Text size=\"small\" leading=\"compact\">\n {review.reference.charAt(0).toUpperCase() + review.reference.slice(1)}\n </Text>\n </div>\n <div className=\"text-ui-fg-subtle grid grid-cols-2 items-start px-6 py-4\">\n <Text size=\"small\" leading=\"compact\" weight=\"plus\">\n Customer Note\n </Text>\n <Text size=\"small\" leading=\"compact\">\n {review.customer_note || \"-\"}\n </Text>\n </div>\n <div className=\"text-ui-fg-subtle grid grid-cols-2 items-start px-6 py-4\">\n <Text size=\"small\" leading=\"compact\" weight=\"plus\">\n Seller Note\n </Text>\n <Text size=\"small\" leading=\"compact\">\n {review.seller_note || \"-\"}\n </Text>\n </div>\n <div className=\"text-ui-fg-subtle grid grid-cols-2 items-center px-6 py-4\">\n <Text size=\"small\" leading=\"compact\" weight=\"plus\">\n Created At\n </Text>\n <Text size=\"small\" leading=\"compact\">\n {new Date(review.created_at).toLocaleDateString(undefined, {\n year: \"numeric\",\n month: \"long\",\n day: \"numeric\",\n hour: \"2-digit\",\n minute: \"2-digit\",\n })}\n </Text>\n </div>\n <div className=\"text-ui-fg-subtle grid grid-cols-2 items-center px-6 py-4\">\n <Text size=\"small\" leading=\"compact\" weight=\"plus\">\n Updated At\n </Text>\n <Text size=\"small\" leading=\"compact\">\n {new Date(review.updated_at).toLocaleDateString(undefined, {\n year: \"numeric\",\n month: \"long\",\n day: \"numeric\",\n hour: \"2-digit\",\n minute: \"2-digit\",\n })}\n </Text>\n </div>\n </Container>\n );\n};\n\nexport const ReviewDetailPage = () => {\n const { id } = useParams();\n\n const { review, isLoading, isError, error } = useReview(id!);\n\n if (isLoading || !review) {\n return <SingleColumnPageSkeleton sections={1} />;\n }\n\n if (isError) {\n throw error;\n }\n\n return (\n <SingleColumnPage showMetadata>\n <ReviewGeneralSection review={review} />\n </SingleColumnPage>\n );\n};\n\nexport default ReviewDetailPage;\n",
- "type": "registry:vendor"
- },
- {
- "path": "reviews/vendor/routes/reviews/[id]/breadcrumb.tsx",
- "content": "import { UIMatch } from \"react-router-dom\"\n\nimport { useReview } from \"../../../hooks/api/reviews\"\n\nexport const Breadcrumb = (props: UIMatch) => {\n const { id } = props.params || {}\n\n const { review } = useReview(id!, undefined, {\n enabled: Boolean(id),\n })\n\n if (!review) {\n return null\n }\n\n return <span>{review.id}</span>\n}\n",
- "type": "registry:vendor"
- },
- {
- "path": "reviews/admin/hooks/api/reviews.tsx",
- "content": "import { useQuery, UseQueryOptions } from \"@tanstack/react-query\";\nimport { queryKeysFactory } from \"@mercurjs/dashboard-shared\";\nimport { client } from \"../../lib/client\";\nimport {\n ClientError,\n InferClientInput,\n InferClientOutput,\n} from \"@mercurjs/client\";\n\nconst REVIEWS_QUERY_KEY = \"admin_reviews\" as const;\nexport const reviewsQueryKeys = queryKeysFactory(REVIEWS_QUERY_KEY);\n\nexport type ReviewDTO = InferClientOutput<\n typeof client.admin.reviews.$id.query\n>[\"review\"];\n\nexport const useReviews = (\n query?: InferClientInput<typeof client.admin.reviews.query>,\n options?: Omit<\n UseQueryOptions<\n unknown,\n ClientError,\n InferClientOutput<typeof client.admin.reviews.query>\n >,\n \"queryKey\" | \"queryFn\"\n >,\n) => {\n const { data, ...rest } = useQuery({\n queryKey: reviewsQueryKeys.list(query),\n queryFn: async () =>\n client.admin.reviews.query({\n ...query,\n }),\n ...options,\n });\n\n return { ...data, ...rest };\n};\n\nexport const useReview = (\n id: string,\n query?: InferClientInput<typeof client.admin.reviews.$id.query>,\n options?: Omit<\n UseQueryOptions<\n unknown,\n ClientError,\n InferClientOutput<typeof client.admin.reviews.$id.query>\n >,\n \"queryKey\" | \"queryFn\"\n >,\n) => {\n const { data, ...rest } = useQuery({\n queryKey: reviewsQueryKeys.detail(id, query),\n queryFn: async () =>\n client.admin.reviews.$id.query({\n $id: id,\n ...query,\n }),\n ...options,\n });\n\n return { ...data, ...rest };\n};\n",
- "type": "registry:admin"
- },
- {
- "path": "reviews/admin/hooks/table/columns/use-review-table-columns.tsx",
- "content": "import { createColumnHelper } from \"@tanstack/react-table\";\nimport { useMemo } from \"react\";\nimport { StatusBadge, Text } from \"@medusajs/ui\";\nimport { DateCell, DateHeader } from \"@mercurjs/dashboard-shared\";\nimport { ReviewDTO } from \"../../api/reviews\";\n\nconst columnHelper = createColumnHelper<ReviewDTO>();\n\nconst ratingColor = (rating: number) => {\n if (rating >= 4) return \"green\" as const;\n if (rating >= 3) return \"orange\" as const;\n return \"red\" as const;\n};\n\nexport const useReviewTableColumns = () => {\n return useMemo(\n () => [\n columnHelper.accessor(\"rating\", {\n header: () => (\n <div className=\"flex h-full w-full items-center\">\n <span className=\"truncate\">Rating</span>\n </div>\n ),\n cell: ({ getValue }) => {\n const rating = getValue();\n return (\n <StatusBadge color={ratingColor(rating)}>{rating} / 5</StatusBadge>\n );\n },\n }),\n columnHelper.accessor(\"reference\", {\n header: () => (\n <div className=\"flex h-full w-full items-center\">\n <span className=\"truncate\">Reference</span>\n </div>\n ),\n cell: ({ getValue }) => {\n const reference = getValue();\n return (\n <Text size=\"small\" leading=\"compact\" className=\"text-ui-fg-subtle\">\n {reference.charAt(0).toUpperCase() + reference.slice(1)}\n </Text>\n );\n },\n }),\n columnHelper.accessor(\"customer_note\", {\n header: () => (\n <div className=\"flex h-full w-full items-center\">\n <span className=\"truncate\">Customer Note</span>\n </div>\n ),\n cell: ({ getValue }) => {\n const note = getValue();\n return (\n <div className=\"flex h-full w-full items-center overflow-hidden\">\n <Text\n size=\"small\"\n leading=\"compact\"\n className=\"text-ui-fg-subtle truncate\"\n >\n {note || \"-\"}\n </Text>\n </div>\n );\n },\n }),\n columnHelper.accessor(\"created_at\", {\n header: () => <DateHeader />,\n cell: ({ getValue }) => {\n const date = new Date(getValue());\n return <DateCell date={date} />;\n },\n }),\n ],\n [],\n );\n};\n",
- "type": "registry:admin"
- },
- {
- "path": "reviews/admin/hooks/table/filters/use-review-table-filters.tsx",
- "content": "import { useTranslation } from \"react-i18next\";\nimport { useMemo } from \"react\";\n\nimport type { Filter } from \"@mercurjs/dashboard-shared\";\n\nexport const useReviewTableFilters = (): Filter[] => {\n const { t } = useTranslation();\n\n return useMemo(() => {\n const filters: Filter[] = [];\n\n const dateFilters: Filter[] = [\n { label: t(\"fields.createdAt\"), key: \"created_at\" },\n { label: t(\"fields.updatedAt\"), key: \"updated_at\" },\n ].map((f) => ({\n key: f.key,\n label: f.label,\n type: \"date\",\n }));\n\n filters.push(...dateFilters);\n\n return filters;\n }, [t]);\n};\n",
- "type": "registry:admin"
- },
- {
- "path": "reviews/admin/hooks/table/query/use-review-table-query.tsx",
- "content": "import { useQueryParams } from \"@mercurjs/dashboard-shared\";\n\ntype UseReviewTableQueryProps = {\n prefix?: string;\n pageSize?: number;\n};\n\nexport const useReviewTableQuery = ({\n prefix,\n pageSize = 20,\n}: UseReviewTableQueryProps) => {\n const queryObject = useQueryParams(\n [\"offset\", \"q\", \"created_at\", \"updated_at\", \"order\"],\n prefix,\n );\n\n const { offset, created_at, updated_at, q, order } = queryObject;\n\n const searchParams: Record<string, any> = {\n limit: pageSize,\n offset: offset ? Number(offset) : 0,\n created_at: created_at ? JSON.parse(created_at) : undefined,\n updated_at: updated_at ? JSON.parse(updated_at) : undefined,\n order: order ? order : \"-created_at\",\n q,\n };\n\n return {\n searchParams,\n raw: queryObject,\n };\n};\n",
- "type": "registry:admin"
- },
- {
- "path": "reviews/admin/routes/reviews/page.tsx",
- "content": "import { useTranslation } from \"react-i18next\";\nimport { keepPreviousData } from \"@tanstack/react-query\";\nimport { Container, Heading } from \"@medusajs/ui\";\nimport { Star } from \"@medusajs/icons\";\nimport type { RouteConfig } from \"@mercurjs/dashboard-sdk\";\n\nimport { useReviews } from \"../../hooks/api/reviews\";\nimport { useReviewTableColumns } from \"../../hooks/table/columns/use-review-table-columns\";\nimport { useReviewTableQuery } from \"../../hooks/table/query/use-review-table-query\";\nimport { useReviewTableFilters } from \"../../hooks/table/filters/use-review-table-filters\";\nimport {\n _DataTable,\n SingleColumnPage,\n useDataTable,\n} from \"@mercurjs/dashboard-shared\";\n\nconst PAGE_SIZE = 10;\n\nconst ReviewListPage = () => {\n const { t } = useTranslation();\n const { raw, searchParams } = useReviewTableQuery({\n pageSize: PAGE_SIZE,\n });\n\n const { reviews, count, isError, error, isLoading } = useReviews(\n searchParams,\n {\n placeholderData: keepPreviousData,\n },\n );\n\n const columns = useReviewTableColumns();\n const filters = useReviewTableFilters();\n\n const { table } = useDataTable({\n data: reviews ?? [],\n columns,\n enablePagination: true,\n count: count,\n pageSize: PAGE_SIZE,\n });\n\n if (isError) {\n throw error;\n }\n\n return (\n <SingleColumnPage>\n <Container className=\"divide-y p-0\">\n <div className=\"flex items-center justify-between px-6 py-4\">\n <Heading>Reviews</Heading>\n </div>\n <_DataTable\n columns={columns}\n table={table}\n pagination\n filters={filters}\n navigateTo={(row) => `/reviews/${row.original.id}`}\n count={count}\n isLoading={isLoading}\n pageSize={PAGE_SIZE}\n orderBy={[\n {\n key: \"created_at\",\n label: t(\"fields.createdAt\"),\n },\n {\n key: \"updated_at\",\n label: t(\"fields.updatedAt\"),\n },\n ]}\n queryObject={raw}\n noRecords={{\n message: \"No reviews found\",\n }}\n />\n </Container>\n </SingleColumnPage>\n );\n};\n\nexport default ReviewListPage;\n\nexport const config: RouteConfig = {\n label: \"Reviews\",\n icon: Star,\n};\n",
- "type": "registry:admin"
- },
- {
- "path": "reviews/admin/routes/reviews/[id]/page.tsx",
- "content": "import { useParams } from \"react-router-dom\";\nimport { Container, Heading, StatusBadge, Text } from \"@medusajs/ui\";\n\nimport {\n SingleColumnPageSkeleton,\n SingleColumnPage,\n} from \"@mercurjs/dashboard-shared\";\nimport { useReview, ReviewDTO } from \"../../../hooks/api/reviews\";\n\nconst ratingColor = (rating: number) => {\n if (rating >= 4) return \"green\" as const;\n if (rating >= 3) return \"orange\" as const;\n return \"red\" as const;\n};\n\nconst ReviewGeneralSection = ({ review }: { review: ReviewDTO }) => {\n return (\n <Container className=\"divide-y p-0\">\n <div className=\"flex items-center justify-between px-6 py-4\">\n <Heading>{review.id}</Heading>\n <div className=\"flex items-center gap-x-2\">\n <StatusBadge color={ratingColor(review.rating)}>\n {review.rating} / 5\n </StatusBadge>\n </div>\n </div>\n <div className=\"text-ui-fg-subtle grid grid-cols-2 items-center px-6 py-4\">\n <Text size=\"small\" leading=\"compact\" weight=\"plus\">\n Reference\n </Text>\n <Text size=\"small\" leading=\"compact\">\n {review.reference.charAt(0).toUpperCase() + review.reference.slice(1)}\n </Text>\n </div>\n <div className=\"text-ui-fg-subtle grid grid-cols-2 items-start px-6 py-4\">\n <Text size=\"small\" leading=\"compact\" weight=\"plus\">\n Customer Note\n </Text>\n <Text size=\"small\" leading=\"compact\">\n {review.customer_note || \"-\"}\n </Text>\n </div>\n <div className=\"text-ui-fg-subtle grid grid-cols-2 items-start px-6 py-4\">\n <Text size=\"small\" leading=\"compact\" weight=\"plus\">\n Seller Note\n </Text>\n <Text size=\"small\" leading=\"compact\">\n {review.seller_note || \"-\"}\n </Text>\n </div>\n <div className=\"text-ui-fg-subtle grid grid-cols-2 items-center px-6 py-4\">\n <Text size=\"small\" leading=\"compact\" weight=\"plus\">\n Created At\n </Text>\n <Text size=\"small\" leading=\"compact\">\n {new Date(review.created_at).toLocaleDateString(undefined, {\n year: \"numeric\",\n month: \"long\",\n day: \"numeric\",\n hour: \"2-digit\",\n minute: \"2-digit\",\n })}\n </Text>\n </div>\n <div className=\"text-ui-fg-subtle grid grid-cols-2 items-center px-6 py-4\">\n <Text size=\"small\" leading=\"compact\" weight=\"plus\">\n Updated At\n </Text>\n <Text size=\"small\" leading=\"compact\">\n {new Date(review.updated_at).toLocaleDateString(undefined, {\n year: \"numeric\",\n month: \"long\",\n day: \"numeric\",\n hour: \"2-digit\",\n minute: \"2-digit\",\n })}\n </Text>\n </div>\n </Container>\n );\n};\n\nexport const ReviewDetailPage = () => {\n const { id } = useParams();\n\n const { review, isLoading, isError, error } = useReview(id!);\n\n if (isLoading || !review) {\n return <SingleColumnPageSkeleton sections={1} />;\n }\n\n if (isError) {\n throw error;\n }\n\n return (\n <SingleColumnPage showMetadata>\n <ReviewGeneralSection review={review} />\n </SingleColumnPage>\n );\n};\n\nexport default ReviewDetailPage;\n",
- "type": "registry:admin"
- },
- {
- "path": "reviews/admin/routes/reviews/[id]/breadcrumb.tsx",
- "content": "import { UIMatch } from \"react-router-dom\"\n\nimport { useReview } from \"../../../hooks/api/reviews\"\n\nexport const Breadcrumb = (props: UIMatch) => {\n const { id } = props.params || {}\n\n const { review } = useReview(id!, undefined, {\n enabled: Boolean(id),\n })\n\n if (!review) {\n return null\n }\n\n return <span>{review.id}</span>\n}\n",
- "type": "registry:admin"
- }
- ]
-}
\ No newline at end of file
diff --git a/packages/registry/registry.json b/packages/registry/registry.json
index c91c3f7a7..d9d5bfa5b 100644
--- a/packages/registry/registry.json
+++ b/packages/registry/registry.json
@@ -3,222 +3,6 @@
"name": "@mercurjs",
"homepage": "https://mercurjs.com",
"items": [
- {
- "name": "reviews",
- "description": "A review system with product and seller reviews, ratings, customer/vendor/admin API routes, and workflows.",
- "dependencies": [],
- "registryDependencies": [],
- "docs": "## Configuration\n\nAdd the review module to your `medusa-config.ts`:\n\n```ts\nmodules: [\n {\n resolve: './modules/reviews',\n },\n]\n```\n\n## Middlewares\n\nAdd the review middlewares to your `api/middlewares.ts`:\n\n```ts\nimport { defineMiddlewares } from \"@medusajs/medusa\";\nimport { adminReviewsMiddlewares } from \"./admin/reviews/middlewares\";\nimport { vendorReviewsMiddlewares } from \"./vendor/reviews/middlewares\";\nimport { storeReviewMiddlewares } from \"./store/reviews/middlewares\";\n\nexport default defineMiddlewares({\n routes: [...adminReviewsMiddlewares, ...vendorReviewsMiddlewares, ...storeReviewMiddlewares],\n});\n```\n\nIf you already have a `middlewares.ts` file, merge the review middleware imports and spread them into your existing `routes` array.\n\n## Database Migrations\n\nAfter installing the block and adding the module configuration, generate and run the migrations to create the necessary tables in your database:\n\n```bash\nnpx medusa db:generate reviews\nnpx medusa db:migrate\n```",
- "files": [
- {
- "path": "reviews/modules/reviews/index.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/modules/reviews/service.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/modules/reviews/models/review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/modules/reviews/types/index.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/modules/reviews/types/common.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/modules/reviews/types/mutations.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/links/customer-review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/links/order-review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/links/product-review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/links/seller-review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/index.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/steps/index.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/steps/create-review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/steps/update-review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/steps/delete-review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/steps/validate-review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/workflows/index.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/workflows/create-review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/workflows/update-review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/workflows/review/workflows/delete-review.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/admin/reviews/route.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/admin/reviews/middlewares.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/admin/reviews/query-config.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/admin/reviews/validators.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/admin/reviews/[id]/route.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/store/reviews/route.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/store/reviews/middlewares.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/store/reviews/helpers.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/store/reviews/query-config.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/store/reviews/validators.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/store/reviews/[id]/route.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/vendor/reviews/middlewares.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/vendor/reviews/helpers.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/vendor/reviews/query-config.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/vendor/reviews/validators.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/vendor/reviews/route.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/api/vendor/reviews/[id]/route.ts",
- "type": "registry:api"
- },
- {
- "path": "reviews/vendor/hooks/api/reviews.tsx",
- "type": "registry:vendor"
- },
- {
- "path": "reviews/vendor/hooks/table/columns/use-review-table-columns.tsx",
- "type": "registry:vendor"
- },
- {
- "path": "reviews/vendor/hooks/table/filters/use-review-table-filters.tsx",
- "type": "registry:vendor"
- },
- {
- "path": "reviews/vendor/hooks/table/query/use-review-table-query.tsx",
- "type": "registry:vendor"
- },
- {
- "path": "reviews/vendor/routes/reviews/page.tsx",
- "type": "registry:vendor"
- },
- {
- "path": "reviews/vendor/routes/reviews/[id]/page.tsx",
- "type": "registry:vendor"
- },
- {
- "path": "reviews/vendor/routes/reviews/[id]/breadcrumb.tsx",
- "type": "registry:vendor"
- },
- {
- "path": "reviews/admin/hooks/api/reviews.tsx",
- "type": "registry:admin"
- },
- {
- "path": "reviews/admin/hooks/table/columns/use-review-table-columns.tsx",
- "type": "registry:admin"
- },
- {
- "path": "reviews/admin/hooks/table/filters/use-review-table-filters.tsx",
- "type": "registry:admin"
- },
- {
- "path": "reviews/admin/hooks/table/query/use-review-table-query.tsx",
- "type": "registry:admin"
- },
- {
- "path": "reviews/admin/routes/reviews/page.tsx",
- "type": "registry:admin"
- },
- {
- "path": "reviews/admin/routes/reviews/[id]/page.tsx",
- "type": "registry:admin"
- },
- {
- "path": "reviews/admin/routes/reviews/[id]/breadcrumb.tsx",
- "type": "registry:admin"
- }
- ],
- "categories": [
- "reviews"
- ]
- },
{
"name": "product-import-export",
"description": "CSV product import & export for vendors. Includes API routes, workflows, and vendor portal drawers.",
diff --git a/packages/registry/src/reviews/admin/hooks/api/reviews.tsx b/packages/registry/src/reviews/admin/hooks/api/reviews.tsx
deleted file mode 100644
index 22d4a1421..000000000
--- a/packages/registry/src/reviews/admin/hooks/api/reviews.tsx
+++ /dev/null
@@ -1,63 +0,0 @@
-import { useQuery, UseQueryOptions } from "@tanstack/react-query";
-import { queryKeysFactory } from "@mercurjs/dashboard-shared";
-import { client } from "../../lib/client";
-import {
- ClientError,
- InferClientInput,
- InferClientOutput,
-} from "@mercurjs/client";
-
-const REVIEWS_QUERY_KEY = "admin_reviews" as const;
-export const reviewsQueryKeys = queryKeysFactory(REVIEWS_QUERY_KEY);
-
-export type ReviewDTO = InferClientOutput<
- typeof client.admin.reviews.$id.query
->["review"];
-
-export const useReviews = (
- query?: InferClientInput<typeof client.admin.reviews.query>,
- options?: Omit<
- UseQueryOptions<
- unknown,
- ClientError,
- InferClientOutput<typeof client.admin.reviews.query>
- >,
- "queryKey" | "queryFn"
- >,
-) => {
- const { data, ...rest } = useQuery({
- queryKey: reviewsQueryKeys.list(query),
- queryFn: async () =>
- client.admin.reviews.query({
- ...query,
- }),
- ...options,
- });
-
- return { ...data, ...rest };
-};
-
-export const useReview = (
- id: string,
- query?: InferClientInput<typeof client.admin.reviews.$id.query>,
- options?: Omit<
- UseQueryOptions<
- unknown,
- ClientError,
- InferClientOutput<typeof client.admin.reviews.$id.query>
- >,
- "queryKey" | "queryFn"
- >,
-) => {
- const { data, ...rest } = useQuery({
- queryKey: reviewsQueryKeys.detail(id, query),
- queryFn: async () =>
- client.admin.reviews.$id.query({
- $id: id,
- ...query,
- }),
- ...options,
- });
-
- return { ...data, ...rest };
-};
diff --git a/packages/registry/src/reviews/admin/hooks/table/columns/use-review-table-columns.tsx b/packages/registry/src/reviews/admin/hooks/table/columns/use-review-table-columns.tsx
deleted file mode 100644
index e2842b31a..000000000
--- a/packages/registry/src/reviews/admin/hooks/table/columns/use-review-table-columns.tsx
+++ /dev/null
@@ -1,77 +0,0 @@
-import { createColumnHelper } from "@tanstack/react-table";
-import { useMemo } from "react";
-import { StatusBadge, Text } from "@medusajs/ui";
-import { DateCell, DateHeader } from "@mercurjs/dashboard-shared";
-import { ReviewDTO } from "../../api/reviews";
-
-const columnHelper = createColumnHelper<ReviewDTO>();
-
-const ratingColor = (rating: number) => {
- if (rating >= 4) return "green" as const;
- if (rating >= 3) return "orange" as const;
- return "red" as const;
-};
-
-export const useReviewTableColumns = () => {
- return useMemo(
- () => [
- columnHelper.accessor("rating", {
- header: () => (
- <div className="flex h-full w-full items-center">
- <span className="truncate">Rating</span>
- </div>
- ),
- cell: ({ getValue }) => {
- const rating = getValue();
- return (
- <StatusBadge color={ratingColor(rating)}>{rating} / 5</StatusBadge>
- );
- },
- }),
- columnHelper.accessor("reference", {
- header: () => (
- <div className="flex h-full w-full items-center">
- <span className="truncate">Reference</span>
- </div>
- ),
- cell: ({ getValue }) => {
- const reference = getValue();
- return (
- <Text size="small" leading="compact" className="text-ui-fg-subtle">
- {reference.charAt(0).toUpperCase() + reference.slice(1)}
- </Text>
- );
- },
- }),
- columnHelper.accessor("customer_note", {
- header: () => (
- <div className="flex h-full w-full items-center">
- <span className="truncate">Customer Note</span>
- </div>
- ),
- cell: ({ getValue }) => {
- const note = getValue();
- return (
- <div className="flex h-full w-full items-center overflow-hidden">
- <Text
- size="small"
- leading="compact"
- className="text-ui-fg-subtle truncate"
- >
- {note || "-"}
- </Text>
- </div>
- );
- },
- }),
- columnHelper.accessor("created_at", {
- header: () => <DateHeader />,
- cell: ({ getValue }) => {
- const date = new Date(getValue());
- return <DateCell date={date} />;
- },
- }),
- ],
- [],
- );
-};
diff --git a/packages/registry/src/reviews/admin/hooks/table/filters/use-review-table-filters.tsx b/packages/registry/src/reviews/admin/hooks/table/filters/use-review-table-filters.tsx
deleted file mode 100644
index b2a35f62f..000000000
--- a/packages/registry/src/reviews/admin/hooks/table/filters/use-review-table-filters.tsx
+++ /dev/null
@@ -1,25 +0,0 @@
-import { useTranslation } from "react-i18next";
-import { useMemo } from "react";
-
-import type { Filter } from "@mercurjs/dashboard-shared";
-
-export const useReviewTableFilters = (): Filter[] => {
- const { t } = useTranslation();
-
- return useMemo(() => {
- const filters: Filter[] = [];
-
- const dateFilters: Filter[] = [
- { label: t("fields.createdAt"), key: "created_at" },
- { label: t("fields.updatedAt"), key: "updated_at" },
- ].map((f) => ({
- key: f.key,
- label: f.label,
- type: "date",
- }));
-
- filters.push(...dateFilters);
-
- return filters;
- }, [t]);
-};
diff --git a/packages/registry/src/reviews/admin/hooks/table/query/use-review-table-query.tsx b/packages/registry/src/reviews/admin/hooks/table/query/use-review-table-query.tsx
deleted file mode 100644
index b99f02b39..000000000
--- a/packages/registry/src/reviews/admin/hooks/table/query/use-review-table-query.tsx
+++ /dev/null
@@ -1,32 +0,0 @@
-import { useQueryParams } from "@mercurjs/dashboard-shared";
-
-type UseReviewTableQueryProps = {
- prefix?: string;
- pageSize?: number;
-};
-
-export const useReviewTableQuery = ({
- prefix,
- pageSize = 20,
-}: UseReviewTableQueryProps) => {
- const queryObject = useQueryParams(
- ["offset", "q", "created_at", "updated_at", "order"],
- prefix,
- );
-
- const { offset, created_at, updated_at, q, order } = queryObject;
-
- const searchParams: Record<string, any> = {
- limit: pageSize,
- offset: offset ? Number(offset) : 0,
- created_at: created_at ? JSON.parse(created_at) : undefined,
- updated_at: updated_at ? JSON.parse(updated_at) : undefined,
- order: order ? order : "-created_at",
- q,
- };
-
- return {
- searchParams,
- raw: queryObject,
- };
-};
diff --git a/packages/registry/src/reviews/admin/lib/client.ts b/packages/registry/src/reviews/admin/lib/client.ts
deleted file mode 100644
index 940a25d02..000000000
--- a/packages/registry/src/reviews/admin/lib/client.ts
+++ /dev/null
@@ -1,9 +0,0 @@
-// DO NOT ADD THIS TO registry.json - internal use only for type checking in the mercur monorepo
-import { createClient, InferClient } from "@mercurjs/client"
-import { Routes } from '../../../../.mercur'
-
-declare const __BACKEND_URL__: string
-
-export const client: InferClient<Routes> = createClient({
- baseUrl: __BACKEND_URL__,
-})
diff --git a/packages/registry/src/reviews/admin/pages/reviews/[id]/breadcrumb.tsx b/packages/registry/src/reviews/admin/pages/reviews/[id]/breadcrumb.tsx
deleted file mode 100644
index cbf312112..000000000
--- a/packages/registry/src/reviews/admin/pages/reviews/[id]/breadcrumb.tsx
+++ /dev/null
@@ -1,17 +0,0 @@
-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.id}</span>
-}
diff --git a/packages/registry/src/reviews/admin/pages/reviews/[id]/page.tsx b/packages/registry/src/reviews/admin/pages/reviews/[id]/page.tsx
deleted file mode 100644
index 8fb2f671a..000000000
--- a/packages/registry/src/reviews/admin/pages/reviews/[id]/page.tsx
+++ /dev/null
@@ -1,103 +0,0 @@
-import { useParams } from "react-router-dom";
-import { Container, Heading, StatusBadge, Text } from "@medusajs/ui";
-
-import {
- SingleColumnPageSkeleton,
- SingleColumnPage,
-} from "@mercurjs/dashboard-shared";
-import { useReview, ReviewDTO } from "../../../hooks/api/reviews";
-
-const ratingColor = (rating: number) => {
- if (rating >= 4) return "green" as const;
- if (rating >= 3) return "orange" as const;
- return "red" as const;
-};
-
-const ReviewGeneralSection = ({ review }: { review: ReviewDTO }) => {
- return (
- <Container className="divide-y p-0">
- <div className="flex items-center justify-between px-6 py-4">
- <Heading>{review.id}</Heading>
- <div className="flex items-center gap-x-2">
- <StatusBadge color={ratingColor(review.rating)}>
- {review.rating} / 5
- </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">
- Reference
- </Text>
- <Text size="small" leading="compact">
- {review.reference.charAt(0).toUpperCase() + review.reference.slice(1)}
- </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">
- Customer Note
- </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">
- Seller Note
- </Text>
- <Text size="small" leading="compact">
- {review.seller_note || "-"}
- </Text>
- </div>
- <div className="text-ui-fg-subtle grid grid-cols-2 items-center px-6 py-4">
- <Text size="small" leading="compact" weight="plus">
- Created At
- </Text>
- <Text size="small" leading="compact">
- {new Date(review.created_at).toLocaleDateString(undefined, {
- year: "numeric",
- month: "long",
- day: "numeric",
- hour: "2-digit",
- minute: "2-digit",
- })}
- </Text>
- </div>
- <div className="text-ui-fg-subtle grid grid-cols-2 items-center px-6 py-4">
- <Text size="small" leading="compact" weight="plus">
- Updated At
- </Text>
- <Text size="small" leading="compact">
- {new Date(review.updated_at).toLocaleDateString(undefined, {
- year: "numeric",
- month: "long",
- day: "numeric",
- hour: "2-digit",
- minute: "2-digit",
- })}
- </Text>
- </div>
- </Container>
- );
-};
-
-export const ReviewDetailPage = () => {
- const { id } = useParams();
-
- const { review, isLoading, isError, error } = useReview(id!);
-
- if (isLoading || !review) {
- return <SingleColumnPageSkeleton sections={1} />;
- }
-
- if (isError) {
- throw error;
- }
-
- return (
- <SingleColumnPage showMetadata>
- <ReviewGeneralSection review={review} />
- </SingleColumnPage>
- );
-};
-
-export default ReviewDetailPage;
diff --git a/packages/registry/src/reviews/admin/pages/reviews/page.tsx b/packages/registry/src/reviews/admin/pages/reviews/page.tsx
deleted file mode 100644
index 2e684995f..000000000
--- a/packages/registry/src/reviews/admin/pages/reviews/page.tsx
+++ /dev/null
@@ -1,80 +0,0 @@
-import { useTranslation } from "react-i18next";
-import { keepPreviousData } from "@tanstack/react-query";
-import { Container, Heading } from "@medusajs/ui";
-
-import { useReviews } from "../../hooks/api/reviews";
-import { useReviewTableColumns } from "../../hooks/table/columns/use-review-table-columns";
-import { useReviewTableQuery } from "../../hooks/table/query/use-review-table-query";
-import { useReviewTableFilters } from "../../hooks/table/filters/use-review-table-filters";
-import {
- _DataTable,
- SingleColumnPage,
- useDataTable,
-} from "@mercurjs/dashboard-shared";
-
-const PAGE_SIZE = 10;
-
-const ReviewListPage = () => {
- const { t } = useTranslation();
- const { raw, searchParams } = useReviewTableQuery({
- pageSize: PAGE_SIZE,
- });
-
- const { reviews, count, isError, error, isLoading } = useReviews(
- searchParams,
- {
- placeholderData: keepPreviousData,
- },
- );
-
- const columns = useReviewTableColumns();
- const filters = useReviewTableFilters();
-
- const { table } = useDataTable({
- data: reviews ?? [],
- columns,
- enablePagination: true,
- count: count,
- pageSize: PAGE_SIZE,
- });
-
- if (isError) {
- throw error;
- }
-
- return (
- <SingleColumnPage>
- <Container className="divide-y p-0">
- <div className="flex items-center justify-between px-6 py-4">
- <Heading>Reviews</Heading>
- </div>
- <_DataTable
- columns={columns}
- table={table}
- pagination
- filters={filters}
- navigateTo={(row) => `/reviews/${row.original.id}`}
- count={count}
- isLoading={isLoading}
- pageSize={PAGE_SIZE}
- orderBy={[
- {
- key: "created_at",
- label: t("fields.createdAt"),
- },
- {
- key: "updated_at",
- label: t("fields.updatedAt"),
- },
- ]}
- queryObject={raw}
- noRecords={{
- message: "No reviews found",
- }}
- />
- </Container>
- </SingleColumnPage>
- );
-};
-
-export default ReviewListPage;
diff --git a/packages/registry/src/reviews/admin/routes/reviews/[id]/breadcrumb.tsx b/packages/registry/src/reviews/admin/routes/reviews/[id]/breadcrumb.tsx
deleted file mode 100644
index cbf312112..000000000
--- a/packages/registry/src/reviews/admin/routes/reviews/[id]/breadcrumb.tsx
+++ /dev/null
@@ -1,17 +0,0 @@
-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.id}</span>
-}
diff --git a/packages/registry/src/reviews/admin/routes/reviews/[id]/page.tsx b/packages/registry/src/reviews/admin/routes/reviews/[id]/page.tsx
deleted file mode 100644
index 8fb2f671a..000000000
--- a/packages/registry/src/reviews/admin/routes/reviews/[id]/page.tsx
+++ /dev/null
@@ -1,103 +0,0 @@
-import { useParams } from "react-router-dom";
-import { Container, Heading, StatusBadge, Text } from "@medusajs/ui";
-
-import {
- SingleColumnPageSkeleton,
- SingleColumnPage,
-} from "@mercurjs/dashboard-shared";
-import { useReview, ReviewDTO } from "../../../hooks/api/reviews";
-
-const ratingColor = (rating: number) => {
- if (rating >= 4) return "green" as const;
- if (rating >= 3) return "orange" as const;
- return "red" as const;
-};
-
-const ReviewGeneralSection = ({ review }: { review: ReviewDTO }) => {
- return (
- <Container className="divide-y p-0">
- <div className="flex items-center justify-between px-6 py-4">
- <Heading>{review.id}</Heading>
- <div className="flex items-center gap-x-2">
- <StatusBadge color={ratingColor(review.rating)}>
- {review.rating} / 5
- </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">
- Reference
- </Text>
- <Text size="small" leading="compact">
- {review.reference.charAt(0).toUpperCase() + review.reference.slice(1)}
- </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">
- Customer Note
- </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">
- Seller Note
- </Text>
- <Text size="small" leading="compact">
- {review.seller_note || "-"}
- </Text>
- </div>
- <div className="text-ui-fg-subtle grid grid-cols-2 items-center px-6 py-4">
- <Text size="small" leading="compact" weight="plus">
- Created At
- </Text>
- <Text size="small" leading="compact">
- {new Date(review.created_at).toLocaleDateString(undefined, {
- year: "numeric",
- month: "long",
- day: "numeric",
- hour: "2-digit",
- minute: "2-digit",
- })}
- </Text>
- </div>
- <div className="text-ui-fg-subtle grid grid-cols-2 items-center px-6 py-4">
- <Text size="small" leading="compact" weight="plus">
- Updated At
- </Text>
- <Text size="small" leading="compact">
- {new Date(review.updated_at).toLocaleDateString(undefined, {
- year: "numeric",
- month: "long",
- day: "numeric",
- hour: "2-digit",
- minute: "2-digit",
- })}
- </Text>
- </div>
- </Container>
- );
-};
-
-export const ReviewDetailPage = () => {
- const { id } = useParams();
-
- const { review, isLoading, isError, error } = useReview(id!);
-
- if (isLoading || !review) {
- return <SingleColumnPageSkeleton sections={1} />;
- }
-
- if (isError) {
- throw error;
- }
-
- return (
- <SingleColumnPage showMetadata>
- <ReviewGeneralSection review={review} />
- </SingleColumnPage>
- );
-};
-
-export default ReviewDetailPage;
diff --git a/packages/registry/src/reviews/admin/routes/reviews/page.tsx b/packages/registry/src/reviews/admin/routes/reviews/page.tsx
deleted file mode 100644
index 14b6477ab..000000000
--- a/packages/registry/src/reviews/admin/routes/reviews/page.tsx
+++ /dev/null
@@ -1,87 +0,0 @@
-import { useTranslation } from "react-i18next";
-import { keepPreviousData } from "@tanstack/react-query";
-import { Container, Heading } from "@medusajs/ui";
-import { Star } from "@medusajs/icons";
-import type { RouteConfig } from "@mercurjs/dashboard-sdk";
-
-import { useReviews } from "../../hooks/api/reviews";
-import { useReviewTableColumns } from "../../hooks/table/columns/use-review-table-columns";
-import { useReviewTableQuery } from "../../hooks/table/query/use-review-table-query";
-import { useReviewTableFilters } from "../../hooks/table/filters/use-review-table-filters";
-import {
- _DataTable,
- SingleColumnPage,
- useDataTable,
-} from "@mercurjs/dashboard-shared";
-
-const PAGE_SIZE = 10;
-
-const ReviewListPage = () => {
- const { t } = useTranslation();
- const { raw, searchParams } = useReviewTableQuery({
- pageSize: PAGE_SIZE,
- });
-
- const { reviews, count, isError, error, isLoading } = useReviews(
- searchParams,
- {
- placeholderData: keepPreviousData,
- },
- );
-
- const columns = useReviewTableColumns();
- const filters = useReviewTableFilters();
-
- const { table } = useDataTable({
- data: reviews ?? [],
- columns,
- enablePagination: true,
- count: count,
- pageSize: PAGE_SIZE,
- });
-
- if (isError) {
- throw error;
- }
-
- return (
- <SingleColumnPage>
- <Container className="divide-y p-0">
- <div className="flex items-center justify-between px-6 py-4">
- <Heading>Reviews</Heading>
- </div>
- <_DataTable
- columns={columns}
- table={table}
- pagination
- filters={filters}
- navigateTo={(row) => `/reviews/${row.original.id}`}
- count={count}
- isLoading={isLoading}
- pageSize={PAGE_SIZE}
- orderBy={[
- {
- key: "created_at",
- label: t("fields.createdAt"),
- },
- {
- key: "updated_at",
- label: t("fields.updatedAt"),
- },
- ]}
- queryObject={raw}
- noRecords={{
- message: "No reviews found",
- }}
- />
- </Container>
- </SingleColumnPage>
- );
-};
-
-export default ReviewListPage;
-
-export const config: RouteConfig = {
- label: "Reviews",
- icon: Star,
-};
diff --git a/packages/registry/src/reviews/api/admin/reviews/[id]/route.ts b/packages/registry/src/reviews/api/admin/reviews/[id]/route.ts
deleted file mode 100644
index cc8bd6253..000000000
--- a/packages/registry/src/reviews/api/admin/reviews/[id]/route.ts
+++ /dev/null
@@ -1,23 +0,0 @@
-import { AuthenticatedMedusaRequest, MedusaResponse } from '@medusajs/framework'
-import { ContainerRegistrationKeys } from '@medusajs/framework/utils'
-
-import { AdminReviewResponse } from '../../../../modules/reviews/types'
-
-export async function GET(
- req: AuthenticatedMedusaRequest,
- res: MedusaResponse<AdminReviewResponse>
-): Promise<void> {
- const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)
-
- const {
- data: [review]
- } = await query.graph({
- entity: 'review',
- fields: req.queryConfig.fields,
- filters: {
- id: req.params.id
- }
- })
-
- res.json({ review })
-}
diff --git a/packages/registry/src/reviews/api/admin/reviews/middlewares.ts b/packages/registry/src/reviews/api/admin/reviews/middlewares.ts
deleted file mode 100644
index 50dbe067e..000000000
--- a/packages/registry/src/reviews/api/admin/reviews/middlewares.ts
+++ /dev/null
@@ -1,25 +0,0 @@
-import { validateAndTransformQuery } from "@medusajs/framework";
-import { MiddlewareRoute } from "@medusajs/medusa";
-
-import { adminReviewsConfig } from "./query-config";
-import { AdminGetReviewsParams } from "./validators";
-
-export const adminReviewsMiddlewares: MiddlewareRoute[] = [
- {
- method: ["GET"],
- matcher: "/admin/reviews",
- middlewares: [
- validateAndTransformQuery(AdminGetReviewsParams, adminReviewsConfig.list),
- ],
- },
- {
- method: ["GET"],
- matcher: "/admin/reviews/:id",
- middlewares: [
- validateAndTransformQuery(
- AdminGetReviewsParams,
- adminReviewsConfig.retrieve
- ),
- ],
- },
-];
diff --git a/packages/registry/src/reviews/api/admin/reviews/query-config.ts b/packages/registry/src/reviews/api/admin/reviews/query-config.ts
deleted file mode 100644
index 0f0885d08..000000000
--- a/packages/registry/src/reviews/api/admin/reviews/query-config.ts
+++ /dev/null
@@ -1,20 +0,0 @@
-export const adminReviewsFields = [
- 'id',
- 'reference',
- 'rating',
- 'customer_note',
- 'seller_note',
- 'created_at',
- 'updated_at'
-]
-
-export const adminReviewsConfig = {
- list: {
- defaults: adminReviewsFields,
- isList: true
- },
- retrieve: {
- defaults: adminReviewsFields,
- isList: false
- }
-}
diff --git a/packages/registry/src/reviews/api/admin/reviews/validators.ts b/packages/registry/src/reviews/api/admin/reviews/validators.ts
deleted file mode 100644
index 43b4f9e65..000000000
--- a/packages/registry/src/reviews/api/admin/reviews/validators.ts
+++ /dev/null
@@ -1,11 +0,0 @@
-import { z } from 'zod'
-
-import { createFindParams } from '@medusajs/medusa/api/utils/validators'
-
-export type AdminGetReviewsParamsType = z.infer<typeof AdminGetReviewsParams>
-export const AdminGetReviewsParams = createFindParams({
- offset: 0,
- limit: 50
-}).extend({
- reference: z.enum(['product', 'seller']).optional()
-})
diff --git a/packages/registry/src/reviews/api/store/reviews/query-config.ts b/packages/registry/src/reviews/api/store/reviews/query-config.ts
deleted file mode 100644
index 8617e8d6a..000000000
--- a/packages/registry/src/reviews/api/store/reviews/query-config.ts
+++ /dev/null
@@ -1,22 +0,0 @@
-export const storeReviewFields = [
- 'id',
- 'reference',
- 'rating',
- 'customer_note',
- 'customer.first_name',
- 'customer.last_name',
- 'seller_note',
- 'created_at',
- 'updated_at'
-]
-
-export const storeReviewQueryConfig = {
- list: {
- defaults: storeReviewFields,
- isList: true
- },
- retrieve: {
- defaults: storeReviewFields,
- isList: false
- }
-}
diff --git a/packages/registry/src/reviews/api/vendor/reviews/[id]/route.ts b/packages/registry/src/reviews/api/vendor/reviews/[id]/route.ts
deleted file mode 100644
index c85b1d1eb..000000000
--- a/packages/registry/src/reviews/api/vendor/reviews/[id]/route.ts
+++ /dev/null
@@ -1,62 +0,0 @@
-import { AuthenticatedMedusaRequest, MedusaResponse } from '@medusajs/framework'
-import { ContainerRegistrationKeys } from '@medusajs/framework/utils'
-
-import { VendorReviewResponse } from '../../../../modules/reviews/types'
-import { updateReviewWorkflow } from '../../../../workflows/review/workflows'
-import { validateSellerReview } from '../helpers'
-import { VendorUpdateReviewType } from '../validators'
-
-export const GET = async (
- req: AuthenticatedMedusaRequest,
- res: MedusaResponse<VendorReviewResponse>
-) => {
- const { id } = req.params
-
- await validateSellerReview(req.scope, req.auth_context.actor_id, id!)
-
- const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)
-
- const {
- data: [review]
- } = await query.graph({
- entity: 'review',
- fields: req.queryConfig.fields,
- filters: {
- id
- }
- })
-
- res.json({
- review
- })
-}
-
-export const POST = async (
- req: AuthenticatedMedusaRequest<VendorUpdateReviewType>,
- res: MedusaResponse<VendorReviewResponse>
-) => {
- const { id } = req.params
-
- await validateSellerReview(req.scope, req.auth_context.actor_id, id!)
-
- const query = req.scope.resolve(ContainerRegistrationKeys.QUERY)
-
- await updateReviewWorkflow.run({
- container: req.scope,
- input: { id, ...req.validatedBody }
- })
-
- const {
- data: [review]
- } = await query.graph({
- entity: 'review',
- fields: req.queryConfig.fields,
- filters: {
- id
- }
- })
-
- res.json({
- review
- })
-}
diff --git a/packages/registry/src/reviews/api/vendor/reviews/validators.ts b/packages/registry/src/reviews/api/vendor/reviews/validators.ts
deleted file mode 100644
index 13c7a5bd7..000000000
--- a/packages/registry/src/reviews/api/vendor/reviews/validators.ts
+++ /dev/null
@@ -1,13 +0,0 @@
-import { z } from "zod";
-import { createFindParams } from "@medusajs/medusa/api/utils/validators";
-
-export type VendorGetReviewsParamsType = z.infer<typeof VendorGetReviewsParams>;
-export const VendorGetReviewsParams = createFindParams({
- offset: 0,
- limit: 50,
-});
-
-export type VendorUpdateReviewType = z.infer<typeof VendorUpdateReview>;
-export const VendorUpdateReview = z.object({
- seller_note: z.string().max(300),
-});
diff --git a/packages/registry/src/reviews/links/customer-review.ts b/packages/registry/src/reviews/links/customer-review.ts
deleted file mode 100644
index 38c17565b..000000000
--- a/packages/registry/src/reviews/links/customer-review.ts
+++ /dev/null
@@ -1,9 +0,0 @@
-import { defineLink } from "@medusajs/framework/utils";
-import CustomerModule from "@medusajs/medusa/customer";
-
-import ReviewModule from "../modules/reviews";
-
-export default defineLink(CustomerModule.linkable.customer, {
- linkable: ReviewModule.linkable.review,
- isList: true,
-});
diff --git a/packages/registry/src/reviews/links/order-review.ts b/packages/registry/src/reviews/links/order-review.ts
deleted file mode 100644
index 20f154706..000000000
--- a/packages/registry/src/reviews/links/order-review.ts
+++ /dev/null
@@ -1,9 +0,0 @@
-import { defineLink } from "@medusajs/framework/utils";
-import OrderModule from "@medusajs/medusa/order";
-
-import ReviewModule from "../modules/reviews";
-
-export default defineLink(OrderModule.linkable.order, {
- linkable: ReviewModule.linkable.review,
- isList: true,
-});
diff --git a/packages/registry/src/reviews/links/product-review.ts b/packages/registry/src/reviews/links/product-review.ts
deleted file mode 100644
index 893ab3198..000000000
--- a/packages/registry/src/reviews/links/product-review.ts
+++ /dev/null
@@ -1,9 +0,0 @@
-import { defineLink } from "@medusajs/framework/utils";
-import ProductModule from "@medusajs/medusa/product";
-
-import ReviewModule from "../modules/reviews";
-
-export default defineLink(ProductModule.linkable.product, {
- linkable: ReviewModule.linkable.review,
- isList: true,
-});
diff --git a/packages/registry/src/reviews/links/seller-review.ts b/packages/registry/src/reviews/links/seller-review.ts
deleted file mode 100644
index 7460753d9..000000000
--- a/packages/registry/src/reviews/links/seller-review.ts
+++ /dev/null
@@ -1,9 +0,0 @@
-import { defineLink } from "@medusajs/framework/utils";
-
-import ReviewModule from "../modules/reviews";
-import SellerModule from "@mercurjs/core/modules/seller";
-
-export default defineLink(SellerModule.linkable.seller, {
- linkable: ReviewModule.linkable.review,
- isList: true,
-});
diff --git a/packages/registry/src/reviews/modules/reviews/index.ts b/packages/registry/src/reviews/modules/reviews/index.ts
deleted file mode 100644
index c5cf92116..000000000
--- a/packages/registry/src/reviews/modules/reviews/index.ts
+++ /dev/null
@@ -1,12 +0,0 @@
-import { Module } from "@medusajs/framework/utils";
-
-import ReviewModuleService from "./service";
-
-export const REVIEW_MODULE = "reviews";
-
-export * from "./types";
-export { ReviewModuleService };
-
-export default Module(REVIEW_MODULE, {
- service: ReviewModuleService,
-});
diff --git a/packages/registry/src/reviews/modules/reviews/models/review.ts b/packages/registry/src/reviews/modules/reviews/models/review.ts
deleted file mode 100644
index 12c9e51b6..000000000
--- a/packages/registry/src/reviews/modules/reviews/models/review.ts
+++ /dev/null
@@ -1,9 +0,0 @@
-import { model } from '@medusajs/framework/utils'
-
-export const Review = model.define('review', {
- id: model.id({ prefix: 'rev' }).primaryKey(),
- reference: model.enum(['product', 'seller']),
- rating: model.number(),
- customer_note: model.text().nullable(),
- seller_note: model.text().nullable()
-})
diff --git a/packages/registry/src/reviews/modules/reviews/service.ts b/packages/registry/src/reviews/modules/reviews/service.ts
deleted file mode 100644
index 1018e9b5a..000000000
--- a/packages/registry/src/reviews/modules/reviews/service.ts
+++ /dev/null
@@ -1,80 +0,0 @@
-import {
- InjectManager,
- MedusaService,
-} from '@medusajs/framework/utils'
-import { Context } from '@medusajs/framework/types'
-import { EntityManager } from '@medusajs/framework/mikro-orm/knex'
-
-import { Review } from './models/review'
-
-class ReviewModuleService extends MedusaService({
- Review
-}) {
- @InjectManager()
- async getAvgRating(
- type: 'seller' | 'product',
- id: string,
- sharedContext?: Context<EntityManager>
- ): Promise<string | null> {
- const knex = sharedContext!.manager!.getKnex()
-
- const joinField = type === 'product' ? 'product_id' : 'seller_id'
- const joinTable =
- type === 'product'
- ? 'product_product_review_review'
- : 'seller_seller_review_review'
-
- const [result] = await knex('review')
- .avg('review.rating')
- .leftJoin(joinTable, `${joinTable}.review_id`, 'review.id')
- .where(`${joinTable}.${joinField}`, id)
-
- return result?.avg ?? null
- }
-
- @InjectManager()
- async getSellersWithRating(
- fields: string[],
- sharedContext?: Context<EntityManager>
- ) {
- const knex = sharedContext!.manager!.getKnex()
-
- const result = await knex
- .select(...fields.map((f) => `seller.${f}`))
- .avg('review.rating as rating')
- .from('seller')
- .leftJoin(
- 'seller_seller_review_review',
- 'seller.id',
- 'seller_seller_review_review.seller_id'
- )
- .leftJoin('review', 'review.id', 'seller_seller_review_review.review_id')
- .groupBy('seller.id')
-
- return result
- }
-
- @InjectManager()
- async getProductsWithRating(
- fields: string[],
- sharedContext?: Context<EntityManager>
- ) {
- const knex = sharedContext!.manager!.getKnex()
-
- const result = await knex
- .select(...fields.map((f) => `product.${f}`))
- .avg('review.rating as rating')
- .from('product')
- .leftJoin(
- 'product_product_review_review',
- 'product.id',
- 'product_product_review_review.product_id'
- )
- .leftJoin('review', 'review.id', 'product_product_review_review.review_id')
- .groupBy('product.id')
-
- return result
- }
-}
-
-export default ReviewModuleService
diff --git a/packages/registry/src/reviews/modules/reviews/types/common.ts b/packages/registry/src/reviews/modules/reviews/types/common.ts
deleted file mode 100644
index 40d4c845d..000000000
--- a/packages/registry/src/reviews/modules/reviews/types/common.ts
+++ /dev/null
@@ -1,40 +0,0 @@
-import { DeleteResponse, PaginatedResponse } from "@mercurjs/types"
-
-export type ReviewReference = "product" | "seller"
-
-export interface ReviewDTO {
- id: string
- reference: ReviewReference
- rating: number
- customer_note: string | null
- seller_note: string | null
- created_at: Date | string
- updated_at: Date | string
- deleted_at: Date | string | null
-}
-
-export interface AdminReviewResponse {
- review: ReviewDTO
-}
-
-export type AdminReviewListResponse = PaginatedResponse<{
- reviews: ReviewDTO[]
-}>
-
-export interface StoreReviewResponse {
- review: ReviewDTO
-}
-
-export type StoreReviewListResponse = PaginatedResponse<{
- reviews: ReviewDTO[]
-}>
-
-export type StoreReviewDeleteResponse = DeleteResponse<"review">
-
-export interface VendorReviewResponse {
- review: ReviewDTO
-}
-
-export type VendorReviewListResponse = PaginatedResponse<{
- reviews: ReviewDTO[]
-}>
diff --git a/packages/registry/src/reviews/modules/reviews/types/index.ts b/packages/registry/src/reviews/modules/reviews/types/index.ts
deleted file mode 100644
index 5d3c3b82a..000000000
--- a/packages/registry/src/reviews/modules/reviews/types/index.ts
+++ /dev/null
@@ -1,2 +0,0 @@
-export * from "./common"
-export * from "./mutations"
diff --git a/packages/registry/src/reviews/modules/reviews/types/mutations.ts b/packages/registry/src/reviews/modules/reviews/types/mutations.ts
deleted file mode 100644
index 5c1a00fb3..000000000
--- a/packages/registry/src/reviews/modules/reviews/types/mutations.ts
+++ /dev/null
@@ -1,17 +0,0 @@
-import { ReviewReference } from "./common"
-
-export interface CreateReviewDTO {
- reference: ReviewReference
- reference_id: string
- rating: number
- customer_note?: string | null
- customer_id: string
- order_id: string
-}
-
-export interface UpdateReviewDTO {
- id: string
- rating?: number
- customer_note?: string | null
- seller_note?: string | null
-}
diff --git a/packages/registry/src/reviews/vendor/hooks/api/reviews.tsx b/packages/registry/src/reviews/vendor/hooks/api/reviews.tsx
deleted file mode 100644
index 34745c655..000000000
--- a/packages/registry/src/reviews/vendor/hooks/api/reviews.tsx
+++ /dev/null
@@ -1,63 +0,0 @@
-import { useQuery, UseQueryOptions } from "@tanstack/react-query";
-import { queryKeysFactory } from "@mercurjs/dashboard-shared";
-import { client } from "../../lib/client";
-import {
- ClientError,
- InferClientInput,
- InferClientOutput,
-} from "@mercurjs/client";
-
-const REVIEWS_QUERY_KEY = "vendor_reviews" as const;
-export const reviewsQueryKeys = queryKeysFactory(REVIEWS_QUERY_KEY);
-
-export type ReviewDTO = InferClientOutput<
- typeof client.vendor.reviews.$id.query
->["review"];
-
-export const useReviews = (
- query?: InferClientInput<typeof client.vendor.reviews.query>,
- options?: Omit<
- UseQueryOptions<
- unknown,
- ClientError,
- InferClientOutput<typeof client.vendor.reviews.query>
- >,
- "queryKey" | "queryFn"
- >,
-) => {
- const { data, ...rest } = useQuery({
- queryKey: reviewsQueryKeys.list(query),
- queryFn: async () =>
- client.vendor.reviews.query({
- ...query,
- }),
- ...options,
- });
-
- return { ...data, ...rest };
-};
-
-export const useReview = (
- id: string,
- query?: InferClientInput<typeof client.vendor.reviews.$id.query>,
- options?: Omit<
- UseQueryOptions<
- unknown,
- ClientError,
- InferClientOutput<typeof client.vendor.reviews.$id.query>
- >,
- "queryKey" | "queryFn"
- >,
-) => {
- const { data, ...rest } = useQuery({
- queryKey: reviewsQueryKeys.detail(id, query),
- queryFn: async () =>
- client.vendor.reviews.$id.query({
- $id: id,
- ...query,
- }),
- ...options,
- });
-
- return { ...data, ...rest };
-};
diff --git a/packages/registry/src/reviews/vendor/hooks/table/columns/use-review-table-columns.tsx b/packages/registry/src/reviews/vendor/hooks/table/columns/use-review-table-columns.tsx
deleted file mode 100644
index e2842b31a..000000000
--- a/packages/registry/src/reviews/vendor/hooks/table/columns/use-review-table-columns.tsx
+++ /dev/null
@@ -1,77 +0,0 @@
-import { createColumnHelper } from "@tanstack/react-table";
-import { useMemo } from "react";
-import { StatusBadge, Text } from "@medusajs/ui";
-import { DateCell, DateHeader } from "@mercurjs/dashboard-shared";
-import { ReviewDTO } from "../../api/reviews";
-
-const columnHelper = createColumnHelper<ReviewDTO>();
-
-const ratingColor = (rating: number) => {
- if (rating >= 4) return "green" as const;
- if (rating >= 3) return "orange" as const;
- return "red" as const;
-};
-
-export const useReviewTableColumns = () => {
- return useMemo(
- () => [
- columnHelper.accessor("rating", {
- header: () => (
- <div className="flex h-full w-full items-center">
- <span className="truncate">Rating</span>
- </div>
- ),
- cell: ({ getValue }) => {
- const rating = getValue();
- return (
- <StatusBadge color={ratingColor(rating)}>{rating} / 5</StatusBadge>
- );
- },
- }),
- columnHelper.accessor("reference", {
- header: () => (
- <div className="flex h-full w-full items-center">
- <span className="truncate">Reference</span>
- </div>
- ),
- cell: ({ getValue }) => {
- const reference = getValue();
- return (
- <Text size="small" leading="compact" className="text-ui-fg-subtle">
- {reference.charAt(0).toUpperCase() + reference.slice(1)}
- </Text>
- );
- },
- }),
- columnHelper.accessor("customer_note", {
- header: () => (
- <div className="flex h-full w-full items-center">
- <span className="truncate">Customer Note</span>
- </div>
- ),
- cell: ({ getValue }) => {
- const note = getValue();
- return (
- <div className="flex h-full w-full items-center overflow-hidden">
- <Text
- size="small"
- leading="compact"
- className="text-ui-fg-subtle truncate"
- >
- {note || "-"}
- </Text>
- </div>
- );
- },
- }),
- columnHelper.accessor("created_at", {
- header: () => <DateHeader />,
- cell: ({ getValue }) => {
- const date = new Date(getValue());
- return <DateCell date={date} />;
- },
- }),
- ],
- [],
- );
-};
diff --git a/packages/registry/src/reviews/vendor/hooks/table/filters/use-review-table-filters.tsx b/packages/registry/src/reviews/vendor/hooks/table/filters/use-review-table-filters.tsx
deleted file mode 100644
index b2a35f62f..000000000
--- a/packages/registry/src/reviews/vendor/hooks/table/filters/use-review-table-filters.tsx
+++ /dev/null
@@ -1,25 +0,0 @@
-import { useTranslation } from "react-i18next";
-import { useMemo } from "react";
-
-import type { Filter } from "@mercurjs/dashboard-shared";
-
-export const useReviewTableFilters = (): Filter[] => {
- const { t } = useTranslation();
-
- return useMemo(() => {
- const filters: Filter[] = [];
-
- const dateFilters: Filter[] = [
- { label: t("fields.createdAt"), key: "created_at" },
- { label: t("fields.updatedAt"), key: "updated_at" },
- ].map((f) => ({
- key: f.key,
- label: f.label,
- type: "date",
- }));
-
- filters.push(...dateFilters);
-
- return filters;
- }, [t]);
-};
diff --git a/packages/registry/src/reviews/vendor/hooks/table/query/use-review-table-query.tsx b/packages/registry/src/reviews/vendor/hooks/table/query/use-review-table-query.tsx
deleted file mode 100644
index b99f02b39..000000000
--- a/packages/registry/src/reviews/vendor/hooks/table/query/use-review-table-query.tsx
+++ /dev/null
@@ -1,32 +0,0 @@
-import { useQueryParams } from "@mercurjs/dashboard-shared";
-
-type UseReviewTableQueryProps = {
- prefix?: string;
- pageSize?: number;
-};
-
-export const useReviewTableQuery = ({
- prefix,
- pageSize = 20,
-}: UseReviewTableQueryProps) => {
- const queryObject = useQueryParams(
- ["offset", "q", "created_at", "updated_at", "order"],
- prefix,
- );
-
- const { offset, created_at, updated_at, q, order } = queryObject;
-
- const searchParams: Record<string, any> = {
- limit: pageSize,
- offset: offset ? Number(offset) : 0,
- created_at: created_at ? JSON.parse(created_at) : undefined,
- updated_at: updated_at ? JSON.parse(updated_at) : undefined,
- order: order ? order : "-created_at",
- q,
- };
-
- return {
- searchParams,
- raw: queryObject,
- };
-};
diff --git a/packages/registry/src/reviews/vendor/lib/client.ts b/packages/registry/src/reviews/vendor/lib/client.ts
deleted file mode 100644
index 940a25d02..000000000
--- a/packages/registry/src/reviews/vendor/lib/client.ts
+++ /dev/null
@@ -1,9 +0,0 @@
-// DO NOT ADD THIS TO registry.json - internal use only for type checking in the mercur monorepo
-import { createClient, InferClient } from "@mercurjs/client"
-import { Routes } from '../../../../.mercur'
-
-declare const __BACKEND_URL__: string
-
-export const client: InferClient<Routes> = createClient({
- baseUrl: __BACKEND_URL__,
-})
diff --git a/packages/registry/src/reviews/vendor/pages/reviews/[id]/breadcrumb.tsx b/packages/registry/src/reviews/vendor/pages/reviews/[id]/breadcrumb.tsx
deleted file mode 100644
index cbf312112..000000000
--- a/packages/registry/src/reviews/vendor/pages/reviews/[id]/breadcrumb.tsx
+++ /dev/null
@@ -1,17 +0,0 @@
-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.id}</span>
-}
diff --git a/packages/registry/src/reviews/vendor/pages/reviews/[id]/page.tsx b/packages/registry/src/reviews/vendor/pages/reviews/[id]/page.tsx
deleted file mode 100644
index 8fb2f671a..000000000
--- a/packages/registry/src/reviews/vendor/pages/reviews/[id]/page.tsx
+++ /dev/null
@@ -1,103 +0,0 @@
-import { useParams } from "react-router-dom";
-import { Container, Heading, StatusBadge, Text } from "@medusajs/ui";
-
-import {
- SingleColumnPageSkeleton,
- SingleColumnPage,
-} from "@mercurjs/dashboard-shared";
-import { useReview, ReviewDTO } from "../../../hooks/api/reviews";
-
-const ratingColor = (rating: number) => {
- if (rating >= 4) return "green" as const;
- if (rating >= 3) return "orange" as const;
- return "red" as const;
-};
-
-const ReviewGeneralSection = ({ review }: { review: ReviewDTO }) => {
- return (
- <Container className="divide-y p-0">
- <div className="flex items-center justify-between px-6 py-4">
- <Heading>{review.id}</Heading>
- <div className="flex items-center gap-x-2">
- <StatusBadge color={ratingColor(review.rating)}>
- {review.rating} / 5
- </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">
- Reference
- </Text>
- <Text size="small" leading="compact">
- {review.reference.charAt(0).toUpperCase() + review.reference.slice(1)}
- </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">
- Customer Note
- </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">
- Seller Note
- </Text>
- <Text size="small" leading="compact">
- {review.seller_note || "-"}
- </Text>
- </div>
- <div className="text-ui-fg-subtle grid grid-cols-2 items-center px-6 py-4">
- <Text size="small" leading="compact" weight="plus">
- Created At
- </Text>
- <Text size="small" leading="compact">
- {new Date(review.created_at).toLocaleDateString(undefined, {
- year: "numeric",
- month: "long",
- day: "numeric",
- hour: "2-digit",
- minute: "2-digit",
- })}
- </Text>
- </div>
- <div className="text-ui-fg-subtle grid grid-cols-2 items-center px-6 py-4">
- <Text size="small" leading="compact" weight="plus">
- Updated At
- </Text>
- <Text size="small" leading="compact">
- {new Date(review.updated_at).toLocaleDateString(undefined, {
- year: "numeric",
- month: "long",
- day: "numeric",
- hour: "2-digit",
- minute: "2-digit",
- })}
- </Text>
- </div>
- </Container>
- );
-};
-
-export const ReviewDetailPage = () => {
- const { id } = useParams();
-
- const { review, isLoading, isError, error } = useReview(id!);
-
- if (isLoading || !review) {
- return <SingleColumnPageSkeleton sections={1} />;
- }
-
- if (isError) {
- throw error;
- }
-
- return (
- <SingleColumnPage showMetadata>
- <ReviewGeneralSection review={review} />
- </SingleColumnPage>
- );
-};
-
-export default ReviewDetailPage;
diff --git a/packages/registry/src/reviews/vendor/pages/reviews/page.tsx b/packages/registry/src/reviews/vendor/pages/reviews/page.tsx
deleted file mode 100644
index 9b2694711..000000000
--- a/packages/registry/src/reviews/vendor/pages/reviews/page.tsx
+++ /dev/null
@@ -1,77 +0,0 @@
-import { useTranslation } from "react-i18next";
-import { keepPreviousData } from "@tanstack/react-query";
-import { Container, Heading } from "@medusajs/ui";
-
-import { _DataTable, SingleColumnPage } from "@mercurjs/dashboard-shared";
-import { useDataTable } from "@mercurjs/dashboard-shared";
-import { useReviews } from "../../hooks/api/reviews";
-import { useReviewTableColumns } from "../../hooks/table/columns/use-review-table-columns";
-import { useReviewTableQuery } from "../../hooks/table/query/use-review-table-query";
-import { useReviewTableFilters } from "../../hooks/table/filters/use-review-table-filters";
-
-const PAGE_SIZE = 10;
-
-const ReviewListPage = () => {
- const { t } = useTranslation();
- const { raw, searchParams } = useReviewTableQuery({
- pageSize: PAGE_SIZE,
- });
-
- const { reviews, count, isError, error, isLoading } = useReviews(
- searchParams,
- {
- placeholderData: keepPreviousData,
- },
- );
-
- const columns = useReviewTableColumns();
- const filters = useReviewTableFilters();
-
- const { table } = useDataTable({
- data: reviews ?? [],
- columns,
- enablePagination: true,
- count: count,
- pageSize: PAGE_SIZE,
- });
-
- if (isError) {
- throw error;
- }
-
- return (
- <SingleColumnPage>
- <Container className="divide-y p-0">
- <div className="flex items-center justify-between px-6 py-4">
- <Heading>Reviews</Heading>
- </div>
- <_DataTable
- columns={columns}
- table={table}
- pagination
- filters={filters}
- navigateTo={(row) => `/reviews/${row.original.id}`}
- count={count}
- isLoading={isLoading}
- pageSize={PAGE_SIZE}
- orderBy={[
- {
- key: "created_at",
- label: t("fields.createdAt"),
- },
- {
- key: "updated_at",
- label: t("fields.updatedAt"),
- },
- ]}
- queryObject={raw}
- noRecords={{
- message: "No reviews found",
- }}
- />
- </Container>
- </SingleColumnPage>
- );
-};
-
-export default ReviewListPage;
diff --git a/packages/registry/src/reviews/vendor/routes/reviews/[id]/breadcrumb.tsx b/packages/registry/src/reviews/vendor/routes/reviews/[id]/breadcrumb.tsx
deleted file mode 100644
index cbf312112..000000000
--- a/packages/registry/src/reviews/vendor/routes/reviews/[id]/breadcrumb.tsx
+++ /dev/null
@@ -1,17 +0,0 @@
-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.id}</span>
-}
diff --git a/packages/registry/src/reviews/vendor/routes/reviews/[id]/page.tsx b/packages/registry/src/reviews/vendor/routes/reviews/[id]/page.tsx
deleted file mode 100644
index 8fb2f671a..000000000
--- a/packages/registry/src/reviews/vendor/routes/reviews/[id]/page.tsx
+++ /dev/null
@@ -1,103 +0,0 @@
-import { useParams } from "react-router-dom";
-import { Container, Heading, StatusBadge, Text } from "@medusajs/ui";
-
-import {
- SingleColumnPageSkeleton,
- SingleColumnPage,
-} from "@mercurjs/dashboard-shared";
-import { useReview, ReviewDTO } from "../../../hooks/api/reviews";
-
-const ratingColor = (rating: number) => {
- if (rating >= 4) return "green" as const;
- if (rating >= 3) return "orange" as const;
- return "red" as const;
-};
-
-const ReviewGeneralSection = ({ review }: { review: ReviewDTO }) => {
- return (
- <Container className="divide-y p-0">
- <div className="flex items-center justify-between px-6 py-4">
- <Heading>{review.id}</Heading>
- <div className="flex items-center gap-x-2">
- <StatusBadge color={ratingColor(review.rating)}>
- {review.rating} / 5
- </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">
- Reference
- </Text>
- <Text size="small" leading="compact">
- {review.reference.charAt(0).toUpperCase() + review.reference.slice(1)}
- </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">
- Customer Note
- </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">
- Seller Note
- </Text>
- <Text size="small" leading="compact">
- {review.seller_note || "-"}
- </Text>
- </div>
- <div className="text-ui-fg-subtle grid grid-cols-2 items-center px-6 py-4">
- <Text size="small" leading="compact" weight="plus">
- Created At
- </Text>
- <Text size="small" leading="compact">
- {new Date(review.created_at).toLocaleDateString(undefined, {
- year: "numeric",
- month: "long",
- day: "numeric",
- hour: "2-digit",
- minute: "2-digit",
- })}
- </Text>
- </div>
- <div className="text-ui-fg-subtle grid grid-cols-2 items-center px-6 py-4">
- <Text size="small" leading="compact" weight="plus">
- Updated At
- </Text>
- <Text size="small" leading="compact">
- {new Date(review.updated_at).toLocaleDateString(undefined, {
- year: "numeric",
- month: "long",
- day: "numeric",
- hour: "2-digit",
- minute: "2-digit",
- })}
- </Text>
- </div>
- </Container>
- );
-};
-
-export const ReviewDetailPage = () => {
- const { id } = useParams();
-
- const { review, isLoading, isError, error } = useReview(id!);
-
- if (isLoading || !review) {
- return <SingleColumnPageSkeleton sections={1} />;
- }
-
- if (isError) {
- throw error;
- }
-
- return (
- <SingleColumnPage showMetadata>
- <ReviewGeneralSection review={review} />
- </SingleColumnPage>
- );
-};
-
-export default ReviewDetailPage;
diff --git a/packages/registry/src/reviews/vendor/routes/reviews/page.tsx b/packages/registry/src/reviews/vendor/routes/reviews/page.tsx
deleted file mode 100644
index 032c012ff..000000000
--- a/packages/registry/src/reviews/vendor/routes/reviews/page.tsx
+++ /dev/null
@@ -1,83 +0,0 @@
-import { useTranslation } from "react-i18next";
-import { keepPreviousData } from "@tanstack/react-query";
-import { Container, Heading } from "@medusajs/ui";
-import { Star } from "@medusajs/icons";
-import type { RouteConfig } from "@mercurjs/dashboard-sdk";
-
-import { _DataTable, SingleColumnPage, useDataTable } from "@mercurjs/dashboard-shared";
-import { useReviews } from "../../hooks/api/reviews";
-import { useReviewTableColumns } from "../../hooks/table/columns/use-review-table-columns";
-import { useReviewTableQuery } from "../../hooks/table/query/use-review-table-query";
-import { useReviewTableFilters } from "../../hooks/table/filters/use-review-table-filters";
-
-const PAGE_SIZE = 10;
-
-const ReviewListPage = () => {
- const { t } = useTranslation();
- const { raw, searchParams } = useReviewTableQuery({
- pageSize: PAGE_SIZE,
- });
-
- const { reviews, count, isError, error, isLoading } = useReviews(
- searchParams,
- {
- placeholderData: keepPreviousData,
- },
- );
-
- const columns = useReviewTableColumns();
- const filters = useReviewTableFilters();
-
- const { table } = useDataTable({
- data: reviews ?? [],
- columns,
- enablePagination: true,
- count: count,
- pageSize: PAGE_SIZE,
- });
-
- if (isError) {
- throw error;
- }
-
- return (
- <SingleColumnPage>
- <Container className="divide-y p-0">
- <div className="flex items-center justify-between px-6 py-4">
- <Heading>Reviews</Heading>
- </div>
- <_DataTable
- columns={columns}
- table={table}
- pagination
- filters={filters}
- navigateTo={(row) => `/reviews/${row.original.id}`}
- count={count}
- isLoading={isLoading}
- pageSize={PAGE_SIZE}
- orderBy={[
- {
- key: "created_at",
- label: t("fields.createdAt"),
- },
- {
- key: "updated_at",
- label: t("fields.updatedAt"),
- },
- ]}
- queryObject={raw}
- noRecords={{
- message: "No reviews found",
- }}
- />
- </Container>
- </SingleColumnPage>
- );
-};
-
-export default ReviewListPage;
-
-export const config: RouteConfig = {
- label: "Reviews",
- icon: Star,
-};
diff --git a/packages/registry/src/reviews/workflows/review/index.ts b/packages/registry/src/reviews/workflows/review/index.ts
deleted file mode 100644
index dfb0d7e07..000000000
--- a/packages/registry/src/reviews/workflows/review/index.ts
+++ /dev/null
@@ -1,2 +0,0 @@
-export * from "./workflows";
-export * from "./steps";
diff --git a/packages/registry/src/reviews/workflows/review/steps/create-review.ts b/packages/registry/src/reviews/workflows/review/steps/create-review.ts
deleted file mode 100644
index 6cebd9b5a..000000000
--- a/packages/registry/src/reviews/workflows/review/steps/create-review.ts
+++ /dev/null
@@ -1,35 +0,0 @@
-import { ContainerRegistrationKeys, Modules } from "@medusajs/framework/utils";
-import { StepResponse, createStep } from "@medusajs/framework/workflows-sdk";
-
-import { REVIEW_MODULE, ReviewModuleService, CreateReviewDTO } from "../../../modules/reviews";
-import { Link } from "@medusajs/framework/modules-sdk";
-
-export const createReviewStep = createStep(
- "create-review",
- async (input: CreateReviewDTO, { container }) => {
- const service = container.resolve<ReviewModuleService>(REVIEW_MODULE);
- const link = container.resolve<Link>(ContainerRegistrationKeys.LINK);
-
- const review = await service.createReviews(input);
-
- await link.create([
- {
- [Modules.CUSTOMER]: {
- customer_id: input.customer_id,
- },
- [REVIEW_MODULE]: {
- review_id: review.id,
- },
- },
- {
- [Modules.ORDER]: {
- order_id: input.order_id,
- },
- [REVIEW_MODULE]: {
- review_id: review.id,
- },
- },
- ]);
- return new StepResponse(review);
- }
-);
diff --git a/packages/registry/src/reviews/workflows/review/steps/delete-review.ts b/packages/registry/src/reviews/workflows/review/steps/delete-review.ts
deleted file mode 100644
index a04b9f8c1..000000000
--- a/packages/registry/src/reviews/workflows/review/steps/delete-review.ts
+++ /dev/null
@@ -1,14 +0,0 @@
-import { StepResponse, createStep } from "@medusajs/framework/workflows-sdk";
-
-import { REVIEW_MODULE, ReviewModuleService } from "../../../modules/reviews";
-
-export const deleteReviewStep = createStep(
- "delete-review",
- async (id: string, { container }) => {
- const service = container.resolve<ReviewModuleService>(REVIEW_MODULE);
-
- await service.softDeleteReviews(id);
-
- return new StepResponse(id);
- }
-);
diff --git a/packages/registry/src/reviews/workflows/review/steps/index.ts b/packages/registry/src/reviews/workflows/review/steps/index.ts
deleted file mode 100644
index ea16c3847..000000000
--- a/packages/registry/src/reviews/workflows/review/steps/index.ts
+++ /dev/null
@@ -1,4 +0,0 @@
-export * from './create-review'
-export * from './update-review'
-export * from './delete-review'
-export * from './validate-review'
diff --git a/packages/registry/src/reviews/workflows/review/steps/update-review.ts b/packages/registry/src/reviews/workflows/review/steps/update-review.ts
deleted file mode 100644
index c11791cc5..000000000
--- a/packages/registry/src/reviews/workflows/review/steps/update-review.ts
+++ /dev/null
@@ -1,14 +0,0 @@
-import { StepResponse, createStep } from "@medusajs/framework/workflows-sdk";
-
-import { REVIEW_MODULE, ReviewModuleService, UpdateReviewDTO } from "../../../modules/reviews";
-
-export const updateReviewStep = createStep(
- "update-review",
- async (input: UpdateReviewDTO, { container }) => {
- const service = container.resolve<ReviewModuleService>(REVIEW_MODULE);
-
- const review = await service.updateReviews(input);
-
- return new StepResponse(review);
- }
-);
diff --git a/packages/registry/src/reviews/workflows/review/workflows/create-review.ts b/packages/registry/src/reviews/workflows/review/workflows/create-review.ts
deleted file mode 100644
index 43d51ee81..000000000
--- a/packages/registry/src/reviews/workflows/review/workflows/create-review.ts
+++ /dev/null
@@ -1,52 +0,0 @@
-import { Modules } from "@medusajs/framework/utils";
-import {
- WorkflowResponse,
- createWorkflow,
- transform,
-} from "@medusajs/framework/workflows-sdk";
-import {
- createRemoteLinkStep,
-} from "@medusajs/medusa/core-flows";
-
-import { CreateReviewDTO, REVIEW_MODULE } from "../../../modules/reviews";
-const SELLER_MODULE = "seller";
-
-import { createReviewStep, validateReviewStep } from "../steps";
-
-export const createReviewWorkflow = createWorkflow(
- {
- name: "create-review",
- },
- function (input: CreateReviewDTO) {
- validateReviewStep(input);
- const review = createReviewStep(input);
-
- const link = transform({ input, review }, ({ input, review }) => {
- return input.reference === "product"
- ? [
- {
- [Modules.PRODUCT]: {
- product_id: input.reference_id,
- },
- [REVIEW_MODULE]: {
- review_id: review.id,
- },
- },
- ]
- : [
- {
- [SELLER_MODULE]: {
- seller_id: input.reference_id,
- },
- [REVIEW_MODULE]: {
- review_id: review.id,
- },
- },
- ];
- });
-
- createRemoteLinkStep(link);
-
- return new WorkflowResponse(review);
- }
-);
diff --git a/packages/registry/src/reviews/workflows/review/workflows/index.ts b/packages/registry/src/reviews/workflows/review/workflows/index.ts
deleted file mode 100644
index 56c73b449..000000000
--- a/packages/registry/src/reviews/workflows/review/workflows/index.ts
+++ /dev/null
@@ -1,3 +0,0 @@
-export * from './create-review'
-export * from './delete-review'
-export * from './update-review'
diff --git a/packages/registry/src/reviews/workflows/review/workflows/update-review.ts b/packages/registry/src/reviews/workflows/review/workflows/update-review.ts
deleted file mode 100644
index ab8f87a1c..000000000
--- a/packages/registry/src/reviews/workflows/review/workflows/update-review.ts
+++ /dev/null
@@ -1,18 +0,0 @@
-import {
- WorkflowResponse,
- createWorkflow,
-} from "@medusajs/framework/workflows-sdk";
-
-import { UpdateReviewDTO } from "../../../modules/reviews";
-import { updateReviewStep } from "../steps";
-
-export const updateReviewWorkflow = createWorkflow(
- {
- name: "update-review",
- },
- function (input: UpdateReviewDTO) {
- const review = updateReviewStep(input);
-
- return new WorkflowResponse(review);
- }
-);
diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts
index 6c41c1e8b..2355b295d 100644
--- a/packages/types/src/index.ts
+++ b/packages/types/src/index.ts
@@ -21,6 +21,9 @@ export * from "./offer"
// Promotion cost types
export * from "./promotion-cost"
+// Review types
+export * from "./review"
+
// Product types — explicit re-export overrides Medusa's product surface.
// Mercur's runtime enums and Mercur-extended DTOs (Omit + intersection over
// upstream) win over the wholesale `export * from "@medusajs/types"` above.
diff --git a/packages/types/src/modules.ts b/packages/types/src/modules.ts
index 7706c7896..b710054bc 100644
--- a/packages/types/src/modules.ts
+++ b/packages/types/src/modules.ts
@@ -11,4 +11,5 @@ export enum MercurModules {
ADMIN_UI = "admin_ui",
CODEGEN = "codegen",
PROMOTION_COST = "promotion_cost",
+ REVIEW = "review",
}
diff --git a/packages/types/src/review/common.ts b/packages/types/src/review/common.ts
index 80fbcf368..cf83009cb 100644
--- a/packages/types/src/review/common.ts
+++ b/packages/types/src/review/common.ts
@@ -1,9 +1,46 @@
-export type ReviewDTO = {
+import { DeleteResponse, PaginatedResponse } from "@medusajs/types"
+
+export type ReviewReference = "product" | "seller"
+
+export type ReviewStatus = "pending" | "published" | "rejected"
+
+export interface ReviewDTO {
id: string
- reference: "product" | "seller"
+ display_id: number
+ reference: ReviewReference
rating: number
customer_note: string | null
seller_note: string | null
- created_at: Date
- updated_at: Date | null
+ status: ReviewStatus
+ created_at: Date | string
+ updated_at: Date | string | null
+ deleted_at?: Date | string | null
}
+
+export interface AdminReviewResponse {
+ review: ReviewDTO
+}
+
+export type AdminReviewListResponse = PaginatedResponse<{
+ reviews: ReviewDTO[]
+}>
+
+export type AdminReviewDeleteResponse = DeleteResponse<"review">
+
+export interface StoreReviewResponse {
+ review: ReviewDTO
+}
+
+export type StoreReviewListResponse = PaginatedResponse<{
+ reviews: ReviewDTO[]
+}>
+
+export type StoreReviewDeleteResponse = DeleteResponse<"review">
+
+export interface VendorReviewResponse {
+ review: ReviewDTO
+}
+
+export type VendorReviewListResponse = PaginatedResponse<{
+ reviews: ReviewDTO[]
+}>
diff --git a/packages/types/src/review/mutation.ts b/packages/types/src/review/mutation.ts
index a50980cf7..4353cacea 100644
--- a/packages/types/src/review/mutation.ts
+++ b/packages/types/src/review/mutation.ts
@@ -1,15 +1,23 @@
-export type CreateReviewDTO = {
+import { ReviewReference, ReviewStatus } from "./common"
+
+export interface CreateReviewDTO {
order_id: string
- reference: "product" | "seller"
+ reference: ReviewReference
reference_id: string
rating: number
- customer_note: string | null
+ customer_note?: string | null
customer_id: string
}
-export type UpdateReviewDTO = {
+export interface UpdateReviewDTO {
id: string
rating?: number
- customer_note?: string
- seller_note?: string
+ customer_note?: string | null
+ seller_note?: string | null
+ status?: ReviewStatus
+}
+
+export interface RespondReviewDTO {
+ id: string
+ seller_note: string
}
diff --git a/packages/vendor/src/lib/query-key-factory.ts b/packages/vendor/src/lib/query-key-factory.ts
index 8510217ea..0c6d55477 100644
--- a/packages/vendor/src/lib/query-key-factory.ts
+++ b/packages/vendor/src/lib/query-key-factory.ts
@@ -36,18 +36,19 @@ export const queryKeysFactory = <
>(
globalKey: T
) => {
- const queryKeyFactory: TQueryKey<T, TListQueryType, TDetailQueryType> = {
+ type Keys = TQueryKey<T, TListQueryType, TDetailQueryType>
+ const queryKeyFactory: Keys = {
all: [globalKey],
lists: () => [...queryKeyFactory.all, "list"],
list: (query?: TListQueryType) =>
[...queryKeyFactory.lists(), query ? { query } : undefined].filter(
(k) => !!k
- ),
+ ) as unknown as ReturnType<Keys["list"]>,
details: () => [...queryKeyFactory.all, "detail"],
detail: (id: TDetailQueryType, query?: TListQueryType) =>
[...queryKeyFactory.details(), id, query ? { query } : undefined].filter(
(k) => !!k
- ),
+ ) as unknown as ReturnType<Keys["detail"]>,
}
return queryKeyFactory
}