Product Reviews

@nakamotosbutt/medusa-product-reviews-enhanced

An enhanced plugin that adds comprehensive product review and moderation capabilities to your Medusa application, with advanced filtering, pagination, and admin UI integration.

Enhanced version with improved admin UI, filtering capabilities, and better integration with Medusa v2.

Features

See a demo in our Medusa Starter

• Product reviews with ratings (1-5 stars)
• Review statistics and analytics
• Review moderation workflow (approved/pending/flagged)
• Admin response management
• SDK for Store and Admin operations
• Enhanced Admin UI with:
  • Advanced filtering (product, status, rating, date range, search)
  • Pagination with customizable page size
  • Direct page navigation
  • Bulk operations support
  • Dark theme integration with Medusa UI
• Improved API with:
  • Full-text search across reviews
  • Date range filtering
  • Rating-based filtering
  • Product-specific filtering

Prerequisites

• Medusa >=2.5.0 backend
• PostgreSQL

Installation and Configuration

1. Install the plugin:

1yarn add @lambdacurry/medusa-product-reviews
2
3# or, if you're using yarn workspaces
4yarn workspace my-app add @lambdacurry/medusa-product-reviews

1. Add to medusa-config.ts:

1module.exports = defineConfig({
2  plugins: [
3    {
4      resolve: '@lambdacurry/medusa-product-reviews',
5      options: {
6        defaultReviewStatus: 'pending', // OPTIONAL, default is 'approved'
7      },
8    },
9  ],
10});

1. Run migrations:

yarn medusa db:migrate

Using the Plugin SDK

The plugin provides a built-in SDK for both store and admin operations using Medusa's native HTTP client.

Store Operations

1// List product reviews
2const { reviews, count } = await sdk.store.productReviews.list(
3  query: StoreListProductReviewsQuery,
4  headers?: ClientHeaders
5);
6
7// Create/Update a review
8const review = await sdk.store.productReviews.upsert(
9  data: StoreUpsertProductReviewsDTO,
10  headers?: ClientHeaders
11);
12
13// Get review statistics
14const stats = await sdk.store.productReviews.listStats(
15  query: StoreListProductReviewStatsQuery,
16  headers?: ClientHeaders
17);

Admin Operations

1// List reviews
2const { reviews, count } = await sdk.admin.productReviews.list(
3  query: AdminListProductReviewsQuery
4);
5
6// Update review status
7const review = await sdk.admin.productReviews.updateStatus(
8  productReviewId: string,
9  status: 'pending' | 'approved' | 'flagged'
10);
11
12// Manage review responses
13const review = await sdk.admin.productReviews.createResponse(
14  productReviewId: string,
15  data: AdminCreateProductReviewResponseDTO
16);
17
18await sdk.admin.productReviews.updateResponse(
19  productReviewId: string,
20  data: AdminUpdateProductReviewResponseDTO
21);
22
23await sdk.admin.productReviews.deleteResponse(
24  productReviewId: string
25);

Review Workflow

1. Creation: Reviews are set to:

   • approved status by default
   • pending status if defaultReviewStatus: 'pending' is set in plugin options

2. Moderation: Admins can:

   • List and filter reviews
   • Update review status (approve/flag)
   • Manage responses (create/update/delete)

Available Endpoints

Admin Endpoints

• GET /admin/product-reviews - List all reviews
• POST /admin/product-reviews/:id/response - Add a response
• PUT /admin/product-reviews/:id/response - Update response
• DELETE /admin/product-reviews/:id/response - Delete response
• PUT /admin/product-reviews/:id/status - Update status

Store Endpoints

• GET /store/product-reviews - List reviews
• POST /store/product-reviews - Create/Update review
• GET /store/product-review-stats - Get statistics

Local Development

IMPORTANT: A running PostgreSQL instance is required. The plugin expects DB_USERNAME and DB_PASSWORD environment variables to be set. If not provided, both default to "postgres".

Available scripts:

1# Build the plugin
2yarn build
3
4# Development mode with hot-reload
5yarn dev
6
7# Publish to local registry for testing
8yarn dev:publish
9
10# Generate database migrations
11yarn db:generate

Installing the plugin in your Medusa project for local development

After publishing the plugin locally by running yarn dev:publish, go to the root of your Medusa project and run the following commands:

1cd path/to/your/medusa-application
2
3yarn medusa plugin:add @lambdacurry/medusa-product-reviews
4
5# If you are yarn with a monorepo, you may also need to run
6yarn install

Compatibility

This plugin is compatible with versions >= 2.5.0 of @medusajs/medusa.

License

MIT License