medusa-plugin-ratings 0.1.0

package/.medusa/server/src/modules/review/service.d.ts

@@ -0,0 +1,139 @@
+import { ReviewActivityType } from './models/review-activity';
+import { ReviewStatus } from './models/review';
+export type ReviewModuleOptions = {
+    defaultStatus?: ReviewStatus;
+};
+declare const ReviewService_base: import("@medusajs/framework/utils").MedusaServiceReturnType<import("@medusajs/framework/utils").ModelConfigurationsToConfigTemplate<{
+    readonly Review: import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder<{
+        id: import("@medusajs/framework/utils").PrimaryKeyModifier<string, import("@medusajs/framework/utils").IdProperty>;
+        status: import("@medusajs/framework/utils").EnumProperty<typeof ReviewStatus>;
+        rating: import("@medusajs/framework/utils").NumberProperty;
+        title: import("@medusajs/framework/utils").NullableModifier<string, import("@medusajs/framework/utils").TextProperty>;
+        body: import("@medusajs/framework/utils").TextProperty;
+        author_name: import("@medusajs/framework/utils").TextProperty;
+        author_email: import("@medusajs/framework/utils").NullableModifier<string, import("@medusajs/framework/utils").TextProperty>;
+        product_id: import("@medusajs/framework/utils").NullableModifier<string, import("@medusajs/framework/utils").TextProperty>;
+        order_id: import("@medusajs/framework/utils").NullableModifier<string, import("@medusajs/framework/utils").TextProperty>;
+        customer_id: import("@medusajs/framework/utils").NullableModifier<string, import("@medusajs/framework/utils").TextProperty>;
+        metadata: import("@medusajs/framework/utils").NullableModifier<Record<string, unknown>, import("@medusajs/framework/utils").JSONProperty>;
+        activity: import("@medusajs/framework/utils").HasMany<() => import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder<{
+            id: import("@medusajs/framework/utils").PrimaryKeyModifier<string, import("@medusajs/framework/utils").IdProperty>;
+            type: import("@medusajs/framework/utils").EnumProperty<typeof ReviewActivityType>;
+            user_id: import("@medusajs/framework/utils").TextProperty;
+            note: import("@medusajs/framework/utils").NullableModifier<string, import("@medusajs/framework/utils").TextProperty>;
+            metadata: import("@medusajs/framework/utils").NullableModifier<Record<string, unknown>, import("@medusajs/framework/utils").JSONProperty>;
+            review: import("@medusajs/framework/utils").BelongsTo<() => import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder</*elided*/ any>, "review">, undefined>;
+        }>, "review_activity">>;
+    }>, "review">;
+    readonly ReviewActivity: import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder<{
+        id: import("@medusajs/framework/utils").PrimaryKeyModifier<string, import("@medusajs/framework/utils").IdProperty>;
+        type: import("@medusajs/framework/utils").EnumProperty<typeof ReviewActivityType>;
+        user_id: import("@medusajs/framework/utils").TextProperty;
+        note: import("@medusajs/framework/utils").NullableModifier<string, import("@medusajs/framework/utils").TextProperty>;
+        metadata: import("@medusajs/framework/utils").NullableModifier<Record<string, unknown>, import("@medusajs/framework/utils").JSONProperty>;
+        review: import("@medusajs/framework/utils").BelongsTo<() => import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder<{
+            id: import("@medusajs/framework/utils").PrimaryKeyModifier<string, import("@medusajs/framework/utils").IdProperty>;
+            status: import("@medusajs/framework/utils").EnumProperty<typeof ReviewStatus>;
+            rating: import("@medusajs/framework/utils").NumberProperty;
+            title: import("@medusajs/framework/utils").NullableModifier<string, import("@medusajs/framework/utils").TextProperty>;
+            body: import("@medusajs/framework/utils").TextProperty;
+            author_name: import("@medusajs/framework/utils").TextProperty;
+            author_email: import("@medusajs/framework/utils").NullableModifier<string, import("@medusajs/framework/utils").TextProperty>;
+            product_id: import("@medusajs/framework/utils").NullableModifier<string, import("@medusajs/framework/utils").TextProperty>;
+            order_id: import("@medusajs/framework/utils").NullableModifier<string, import("@medusajs/framework/utils").TextProperty>;
+            customer_id: import("@medusajs/framework/utils").NullableModifier<string, import("@medusajs/framework/utils").TextProperty>;
+            metadata: import("@medusajs/framework/utils").NullableModifier<Record<string, unknown>, import("@medusajs/framework/utils").JSONProperty>;
+            activity: import("@medusajs/framework/utils").HasMany<() => import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder</*elided*/ any>, "review_activity">>;
+        }>, "review">, undefined>;
+    }>, "review_activity">;
+}>>;
+export declare class ReviewService extends ReviewService_base {
+    protected options_: ReviewModuleOptions;
+    constructor(container: any, options?: ReviewModuleOptions);
+    getOptions(): ReviewModuleOptions;
+    approveReview(id: string, userId: string): Promise<{
+        id: string;
+        status: ReviewStatus;
+        rating: number;
+        title: string | null;
+        body: string;
+        author_name: string;
+        author_email: string | null;
+        product_id: string | null;
+        order_id: string | null;
+        customer_id: string | null;
+        metadata: Record<string, unknown> | null;
+        activity: {
+            id: string;
+            type: ReviewActivityType;
+            user_id: string;
+            note: string | null;
+            metadata: Record<string, unknown> | null;
+            review: /*elided*/ any;
+            created_at: Date;
+            updated_at: Date;
+            deleted_at: Date | null;
+            review_id: string;
+        }[];
+        created_at: Date;
+        updated_at: Date;
+        deleted_at: Date | null;
+    }>;
+    rejectReview(id: string, userId: string): Promise<{
+        id: string;
+        status: ReviewStatus;
+        rating: number;
+        title: string | null;
+        body: string;
+        author_name: string;
+        author_email: string | null;
+        product_id: string | null;
+        order_id: string | null;
+        customer_id: string | null;
+        metadata: Record<string, unknown> | null;
+        activity: {
+            id: string;
+            type: ReviewActivityType;
+            user_id: string;
+            note: string | null;
+            metadata: Record<string, unknown> | null;
+            review: /*elided*/ any;
+            created_at: Date;
+            updated_at: Date;
+            deleted_at: Date | null;
+            review_id: string;
+        }[];
+        created_at: Date;
+        updated_at: Date;
+        deleted_at: Date | null;
+    }>;
+    addNote(reviewId: string, userId: string, note: string): Promise<{
+        id: string;
+        type: ReviewActivityType;
+        user_id: string;
+        note: string | null;
+        metadata: Record<string, unknown> | null;
+        review: {
+            id: string;
+            status: ReviewStatus;
+            rating: number;
+            title: string | null;
+            body: string;
+            author_name: string;
+            author_email: string | null;
+            product_id: string | null;
+            order_id: string | null;
+            customer_id: string | null;
+            metadata: Record<string, unknown> | null;
+            activity: /*elided*/ any[];
+            created_at: Date;
+            updated_at: Date;
+            deleted_at: Date | null;
+        };
+        created_at: Date;
+        updated_at: Date;
+        deleted_at: Date | null;
+        review_id: string;
+    }>;
+}
+export {};

package/.medusa/server/src/modules/review/service.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReviewService = void 0;
+const utils_1 = require("@medusajs/framework/utils");
+const review_1 = require("./models/review");
+const review_activity_1 = require("./models/review-activity");
+const review_2 = require("./models/review");
+class ReviewService extends (0, utils_1.MedusaService)({ Review: review_1.Review, ReviewActivity: review_activity_1.ReviewActivity }) {
+    constructor(container, options) {
+        super(container);
+        this.options_ = {
+            defaultStatus: options?.defaultStatus ?? review_2.ReviewStatus.PENDING
+        };
+    }
+    getOptions() {
+        return this.options_;
+    }
+    async approveReview(id, userId) {
+        const review = await this.updateReviews({ id, status: review_2.ReviewStatus.APPROVED });
+        await this.createReviewActivities({
+            review_id: id,
+            user_id: userId,
+            type: review_activity_1.ReviewActivityType.APPROVE
+        });
+        return review;
+    }
+    async rejectReview(id, userId) {
+        const review = await this.updateReviews({ id, status: review_2.ReviewStatus.REJECTED });
+        await this.createReviewActivities({
+            review_id: id,
+            user_id: userId,
+            type: review_activity_1.ReviewActivityType.REJECT
+        });
+        return review;
+    }
+    async addNote(reviewId, userId, note) {
+        return this.createReviewActivities({
+            review_id: reviewId,
+            user_id: userId,
+            type: review_activity_1.ReviewActivityType.NOTE,
+            note
+        });
+    }
+}
+exports.ReviewService = ReviewService;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VydmljZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uL3NyYy9tb2R1bGVzL3Jldmlldy9zZXJ2aWNlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLHFEQUF5RDtBQUN6RCw0Q0FBd0M7QUFDeEMsOERBQTZFO0FBQzdFLDRDQUE4QztBQU05QyxNQUFhLGFBQWMsU0FBUSxJQUFBLHFCQUFhLEVBQUMsRUFBRSxNQUFNLEVBQU4sZUFBTSxFQUFFLGNBQWMsRUFBZCxnQ0FBYyxFQUFFLENBQUM7SUFHM0UsWUFBWSxTQUFjLEVBQUUsT0FBNkI7UUFDeEQsS0FBSyxDQUFDLFNBQVMsQ0FBQyxDQUFBO1FBQ2hCLElBQUksQ0FBQyxRQUFRLEdBQUc7WUFDZixhQUFhLEVBQUUsT0FBTyxFQUFFLGFBQWEsSUFBSSxxQkFBWSxDQUFDLE9BQU87U0FDN0QsQ0FBQTtJQUNGLENBQUM7SUFFRCxVQUFVO1FBQ1QsT0FBTyxJQUFJLENBQUMsUUFBUSxDQUFBO0lBQ3JCLENBQUM7SUFFRCxLQUFLLENBQUMsYUFBYSxDQUFDLEVBQVUsRUFBRSxNQUFjO1FBQzdDLE1BQU0sTUFBTSxHQUFHLE1BQU0sSUFBSSxDQUFDLGFBQWEsQ0FBQyxFQUFFLEVBQUUsRUFBRSxNQUFNLEVBQUUscUJBQVksQ0FBQyxRQUFRLEVBQUUsQ0FBQyxDQUFBO1FBQzlFLE1BQU0sSUFBSSxDQUFDLHNCQUFzQixDQUFDO1lBQ2pDLFNBQVMsRUFBRSxFQUFFO1lBQ2IsT0FBTyxFQUFFLE1BQU07WUFDZixJQUFJLEVBQUUsb0NBQWtCLENBQUMsT0FBTztTQUNoQyxDQUFDLENBQUE7UUFDRixPQUFPLE1BQU0sQ0FBQTtJQUNkLENBQUM7SUFFRCxLQUFLLENBQUMsWUFBWSxDQUFDLEVBQVUsRUFBRSxNQUFjO1FBQzVDLE1BQU0sTUFBTSxHQUFHLE1BQU0sSUFBSSxDQUFDLGFBQWEsQ0FBQyxFQUFFLEVBQUUsRUFBRSxNQUFNLEVBQUUscUJBQVksQ0FBQyxRQUFRLEVBQUUsQ0FBQyxDQUFBO1FBQzlFLE1BQU0sSUFBSSxDQUFDLHNCQUFzQixDQUFDO1lBQ2pDLFNBQVMsRUFBRSxFQUFFO1lBQ2IsT0FBTyxFQUFFLE1BQU07WUFDZixJQUFJLEVBQUUsb0NBQWtCLENBQUMsTUFBTTtTQUMvQixDQUFDLENBQUE7UUFDRixPQUFPLE1BQU0sQ0FBQTtJQUNkLENBQUM7SUFFRCxLQUFLLENBQUMsT0FBTyxDQUFDLFFBQWdCLEVBQUUsTUFBYyxFQUFFLElBQVk7UUFDM0QsT0FBTyxJQUFJLENBQUMsc0JBQXNCLENBQUM7WUFDbEMsU0FBUyxFQUFFLFFBQVE7WUFDbkIsT0FBTyxFQUFFLE1BQU07WUFDZixJQUFJLEVBQUUsb0NBQWtCLENBQUMsSUFBSTtZQUM3QixJQUFJO1NBQ0osQ0FBQyxDQUFBO0lBQ0gsQ0FBQztDQUNEO0FBMUNELHNDQTBDQyJ9

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Lacey Pevey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,51 @@
+# medusa-plugin-reviews
+
+Product review and rating plugin for Medusa v2 with admin moderation workflow.
+
+[Documentation](https://pevey.com/medusa-plugin-reviews)
+
+If you are not familiar with Medusa, you can learn more on [the project web site](https://www.medusajs.com/).
+
+## Features
+
+- Customer-submitted product reviews with 1-5 star ratings
+- Admin moderation workflow: pending, approved, rejected
+- Bulk approve/reject actions
+- Activity logging for all admin actions and notes
+- Store API with caching (5-minute TTL) for approved reviews
+- Authenticated customers can see their own pending reviews
+- Admin pages for review management with filtering and search
+
+## Installation
+
+Inside your medusa backend root folder:
+
+```bash
+yarn add medusa-plugin-reviews
+```
+
+Replace "yarn add" with the correct command for your package manager if you are using (for example) npm, pnpm, or bun.
+
+## Configuration
+
+Enable in your `medusa-config.ts` file. Example:
+
+```ts
+module.exports = defineConfig({
+	//... other config
+	plugins: [
+		{
+			resolve: 'medusa-plugin-reviews',
+			options: {}
+		}
+		// ... other plugins
+	]
+})
+```
+
+## Usage
+
+- Customers submit reviews via `POST /store/reviews/:productId`.
+- Approved reviews are served via `GET /store/reviews/:productId` with caching.
+- Manage reviews from the Reviews section in the Medusa admin sidebar.
+- Approve or reject reviews individually or in bulk.

package/package.json

@@ -0,0 +1,88 @@
+{
+	"name": "medusa-plugin-ratings",
+	"version": "0.1.0",
+	"description": "Product review and rating plugin for Medusa v2 with moderation workflow",
+	"author": "Lacey Pevey",
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/pevey/medusa-plugins"
+	},
+	"homepage": "https://pevey.com/medusa-plugin-ratings",
+	"files": [
+		".medusa/server"
+	],
+	"exports": {
+		"./package.json": "./package.json",
+		"./admin": {
+			"import": "./.medusa/server/src/admin/index.mjs",
+			"require": "./.medusa/server/src/admin/index.js",
+			"default": "./.medusa/server/src/admin/index.js"
+		},
+		"./.medusa/server/src/modules/*": {
+			"types": "./.medusa/server/src/modules/*/index.d.ts",
+			"default": "./.medusa/server/src/modules/*/index.js"
+		},
+		"./modules/*": {
+			"types": "./.medusa/server/src/modules/*/index.d.ts",
+			"default": "./.medusa/server/src/modules/*/index.js"
+		},
+		"./providers/*": {
+			"types": "./.medusa/server/src/providers/*/index.d.ts",
+			"default": "./.medusa/server/src/providers/*/index.js"
+		},
+		"./*": {
+			"types": "./.medusa/server/src/*.d.ts",
+			"default": "./.medusa/server/src/*.js"
+		},
+		".": {
+			"types": "./.medusa/server/src/modules/review/index.d.ts",
+			"default": "./.medusa/server/src/modules/review/index.js"
+		}
+	},
+	"keywords": [
+		"medusa-v2",
+		"medusa",
+		"reviews",
+		"ratings",
+		"product reviews",
+		"moderation"
+	],
+	"scripts": {
+		"build": "medusa plugin:build",
+		"clean:snapshots": "find . -name '.snapshot-*.json' -path '*/migrations/*' -delete",
+		"dev": "medusa plugin:develop",
+		"prepublishOnly": "medusa plugin:build",
+		"test:unit": "TEST_TYPE=unit NODE_OPTIONS=--experimental-vm-modules jest --silent --runInBand --detectOpenHandles --forceExit --passWithNoTests",
+		"test:integration:http": "TEST_TYPE=integration:http NODE_OPTIONS=--experimental-vm-modules jest --silent=false --runInBand --detectOpenHandles --forceExit"
+	},
+	"devDependencies": {
+		"@medusajs/admin-sdk": "2.13.6",
+		"@medusajs/cli": "2.13.6",
+		"@medusajs/framework": "2.13.6",
+		"@medusajs/icons": "2.13.6",
+		"@medusajs/ui": "4.0.25",
+		"@swc/core": "^1.7.28",
+		"@swc/jest": "^0.2.39",
+		"@types/jest": "^30.0.0",
+		"@types/node": "^20.0.0",
+		"@types/react": "^18.3.2",
+		"@types/react-dom": "^18.2.25",
+		"jest": "^29.7.0",
+		"prop-types": "^15.8.1",
+		"react": "^18.2.0",
+		"react-dom": "^18.2.0",
+		"ts-node": "^10.9.2",
+		"typescript": "^5.6.2",
+		"vite": "^5.2.11",
+		"yalc": "^1.0.0-pre.53"
+	},
+	"peerDependencies": {
+		"@medusajs/framework": "2.13.6",
+		"@medusajs/js-sdk": "2.13.6",
+		"@medusajs/medusa": "2.13.6"
+	},
+	"engines": {
+		"node": ">=20"
+	}
+}