medusa-plugin-ratings 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 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,28 @@
+# medusa-plugin-ratings
+
+Simple reviews and ratings for Medusajs
+
+[Documentation](https://pevey.com/medusa-plugin-ratings)
+
+If you are not familiar with Medusa, you can learn more on [the project web site](https://www.medusajs.com/).
+
+> Medusa is a set of commerce modules and tools that allow you to build rich, reliable, and performant commerce applications without reinventing core commerce logic. The modules can be customized and used to build advanced ecommerce stores, marketplaces, or any product that needs foundational commerce primitives. All modules are open-source and freely available on npm.
+
+## Features
+
+- Adds review object and data repository
+- Adds endpoints for retrieving reviews by product and by customer
+- Adds endpoint for adding a review
+- By default, reviews are set with field `approved` to `false` (boolean)
+- Until Medusa adds extensibility for the admin app, approval must be done manually in the database.
+
+## Configuration
+
+Enable in your medusa-config.js file similar to other plugins:
+
+```bash
+const plugins = [
+  `medusa-plugin-ratings`,
+  ...
+]
+```

package/dist/api/index.js

@@ -0,0 +1,58 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const express_1 = require("express");
+const medusa_core_utils_1 = require("medusa-core-utils");
+const cors_1 = __importDefault(require("cors"));
+const body_parser_1 = __importDefault(require("body-parser"));
+exports.default = (rootDirectory) => {
+    const { configModule } = (0, medusa_core_utils_1.getConfigFile)(rootDirectory, "medusa-config");
+    const { projectConfig } = configModule;
+    const storeCorsOptions = {
+        origin: projectConfig.store_cors.split(","),
+        credentials: true,
+    };
+    const adminCorsOptions = {
+        origin: projectConfig.admin_cors.split(","),
+        credentials: true,
+    };
+    const router = (0, express_1.Router)();
+    router.get("/store/products/:id/reviews", (0, cors_1.default)(storeCorsOptions), (req, res) => {
+        const productReviewService = req.scope.resolve("productReviewService");
+        productReviewService.getProductReviews(req.params.id).then((product_reviews) => {
+            return res.json({
+                product_reviews
+            });
+        });
+    });
+    router.get("/store/customers/:id/reviews", (0, cors_1.default)(storeCorsOptions), (req, res) => {
+        const productReviewService = req.scope.resolve("productReviewService");
+        productReviewService.getCustomerProductReviews(req.params.id).then((product_reviews) => {
+            return res.json({
+                product_reviews
+            });
+        });
+    });
+    router.use(body_parser_1.default.json());
+    router.options("/store/products/:id/reviews", (0, cors_1.default)(storeCorsOptions));
+    router.post("/store/products/:id/reviews", (0, cors_1.default)(storeCorsOptions), (req, res) => {
+        const productReviewService = req.scope.resolve("productReviewService");
+        productReviewService.addProductReview(req.params.id, req.body.customer_id, req.body.display_name, req.body.content, req.body.rating).then((product_review) => {
+            return res.json({
+                product_review
+            });
+        });
+    });
+    router.options("/admin/products/:id/reviews", (0, cors_1.default)(adminCorsOptions));
+    router.get("/admin/products/:id/reviews", (0, cors_1.default)(adminCorsOptions), async (req, res) => {
+        const productReviewService = req.scope.resolve("productReviewService");
+        productReviewService.getProductReviews(req.params.id).then((product_reviews) => {
+            return res.json({
+                product_reviews
+            });
+        });
+    });
+    return router;
+};

package/dist/migrations/1674838435739-ProductReview.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductReview1674838435739 = void 0;
+const typeorm_1 = require("typeorm");
+class ProductReview1674838435739 {
+    async up(queryRunner) {
+        await queryRunner.query(`CREATE TABLE IF NOT EXISTS "product_review" ("id" character varying NOT NULL, 
+            "product_id" character varying NOT NULL, 
+            "customer_id" character varying NOT NULL, 
+            "display_name" character varying NOT NULL, 
+            "rating" integer NOT NULL, 
+            "content" character varying NOT NULL, 
+            "approved" boolean NOT NULL,
+            "created_at" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(), 
+            "updated_at" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now())`);
+        await queryRunner.createPrimaryKey("product_review", ["id"]);
+        await queryRunner.createForeignKey("product_review", new typeorm_1.TableForeignKey({
+            columnNames: ["product_id"],
+            referencedColumnNames: ["id"],
+            referencedTableName: "product",
+            onDelete: "CASCADE",
+            onUpdate: "CASCADE"
+        }));
+    }
+    async down(queryRunner) {
+        await queryRunner.dropTable("product_review", true);
+    }
+}
+exports.ProductReview1674838435739 = ProductReview1674838435739;

package/dist/models/product-review.js

@@ -0,0 +1,76 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductReview = void 0;
+const medusa_1 = require("@medusajs/medusa");
+const utils_1 = require("@medusajs/utils");
+const typeorm_1 = require("typeorm");
+const class_validator_1 = require("class-validator");
+let ProductReview = class ProductReview extends utils_1.BaseEntity {
+    product_id;
+    product;
+    customer_id;
+    customer;
+    display_name;
+    rating;
+    content;
+    approved;
+    beforeInsert() {
+        this.id = (0, utils_1.generateEntityId)(this.id, "prev");
+    }
+};
+__decorate([
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.Column)({ type: "varchar", nullable: true }),
+    __metadata("design:type", String)
+], ProductReview.prototype, "product_id", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => medusa_1.Product),
+    (0, typeorm_1.JoinColumn)({ name: "product_id" }),
+    __metadata("design:type", medusa_1.Product)
+], ProductReview.prototype, "product", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: "varchar", nullable: false }),
+    __metadata("design:type", String)
+], ProductReview.prototype, "customer_id", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => medusa_1.Product),
+    (0, typeorm_1.JoinColumn)({ name: "customer_id" }),
+    __metadata("design:type", medusa_1.Customer)
+], ProductReview.prototype, "customer", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: "varchar", nullable: false }),
+    __metadata("design:type", String)
+], ProductReview.prototype, "display_name", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: "int" }),
+    (0, class_validator_1.Min)(1),
+    (0, class_validator_1.Max)(5),
+    __metadata("design:type", Number)
+], ProductReview.prototype, "rating", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: false }),
+    __metadata("design:type", String)
+], ProductReview.prototype, "content", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: "boolean", nullable: false }),
+    __metadata("design:type", Boolean)
+], ProductReview.prototype, "approved", void 0);
+__decorate([
+    (0, typeorm_1.BeforeInsert)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], ProductReview.prototype, "beforeInsert", null);
+ProductReview = __decorate([
+    (0, typeorm_1.Entity)()
+], ProductReview);
+exports.ProductReview = ProductReview;

package/dist/repositories/product-review.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductReviewRepository = void 0;
+const product_review_1 = require("../models/product-review");
+const database_1 = require("@medusajs/medusa/dist/loaders/database");
+exports.ProductReviewRepository = database_1.dataSource.getRepository(product_review_1.ProductReview);

package/dist/services/product-review.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("@medusajs/utils");
+class ProductReviewService extends utils_1.TransactionBaseService {
+    productReviewRepository_;
+    constructor({ productReviewRepository }) {
+        super(arguments[0]);
+        this.productReviewRepository_ = productReviewRepository;
+    }
+    async getProductReviews(product_id) {
+        const productReviewRepository = this.activeManager_.withRepository(this.productReviewRepository_);
+        return await productReviewRepository.find({
+            where: {
+                product_id,
+                approved: true
+            }
+        });
+    }
+    async getCustomerProductReviews(customer_id) {
+        const productReviewRepository = this.activeManager_.withRepository(this.productReviewRepository_);
+        return await productReviewRepository.find({
+            where: {
+                customer_id,
+                approved: true
+            }
+        });
+    }
+    async addProductReview(product_id, customer_id, display_name, content, rating) {
+        if (!product_id || !customer_id || !display_name || !content || !rating) {
+            throw new Error("product review requires product_id, customer_id, display_name, content, and rating");
+        }
+        const productReviewRepository = this.activeManager_.withRepository(this.productReviewRepository_);
+        const createdReview = productReviewRepository.create({
+            product_id: product_id,
+            customer_id: customer_id,
+            display_name: display_name,
+            content: content,
+            rating: rating,
+            approved: false
+        });
+        const productReview = await productReviewRepository.save(createdReview);
+        return productReview;
+    }
+    async editProductReview(id, display_name, content, rating, approved) {
+        if (!id || !display_name || !content || !rating || !approved) {
+            throw new Error("updating a product review requires id, display_name, content, rating, and approved");
+        }
+        const productReviewRepository = this.activeManager_.withRepository(this.productReviewRepository_);
+        const productReview = productReviewRepository.update(id, {
+            display_name: display_name,
+            content: content,
+            rating: rating,
+            approved: approved
+        });
+        return productReview;
+    }
+}
+exports.default = ProductReviewService;

package/package.json

@@ -0,0 +1,57 @@
+{
+	"name": "medusa-plugin-ratings",
+	"version": "1.0.0",
+	"description": "Simple reviews and ratings for Medusajs",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/pevey/medusa-plugin-ratings"
+	},
+	"homepage": "https://pevey.com/medusa-plugin-ratings",
+	"author": "Lacey Pevey",
+	"license": "MIT",
+	"keywords": [
+		"reviews",
+		"feedback",
+		"ratings",
+		"ecommerce",
+		"headless",
+		"medusa"
+	],
+	"devDependencies": {
+		"@babel/cli": "^7.7.5",
+		"@babel/core": "^7.7.5",
+		"@babel/node": "^7.7.4",
+		"@babel/plugin-proposal-class-properties": "^7.7.4",
+		"@babel/plugin-transform-instanceof": "^7.8.3",
+		"@babel/plugin-transform-runtime": "^7.7.6",
+		"@babel/preset-env": "^7.7.5",
+		"@babel/register": "^7.7.4",
+		"@babel/runtime": "^7.9.6",
+		"awilix": "^8.0.0",
+		"client-sessions": "^0.8.0",
+		"cross-env": "^5.2.1",
+		"jest": "^25.5.2",
+		"medusa-core-utils": "^1.2.0",
+		"medusa-test-utils": "^1.1.40"
+	},
+	"scripts": {
+		"prepare": "cross-env NODE_ENV=production yarn run build",
+		"test": "jest --passWithNoTests src",
+		"build": "babel src --out-dir . --ignore '**/__tests__','**/__mocks__'",
+		"watch": "babel -w src --out-dir . --ignore '**/__tests__','**/__mocks__'"
+	},
+	"peerDependencies": {
+		"@medusajs/medusa": "^1.10.0",
+		"medusa-interfaces": "1.3.7",
+		"typeorm": "npm:@medusajs/typeorm@next",
+		"@medusajs/utils": "1.8.3"
+	},
+	"dependencies": {
+		"@babel/plugin-transform-classes": "^7.9.5",
+		"body-parser": "^1.19.0",
+		"class-validator": "^0.14.0",
+		"cors": "^2.8.5",
+		"express": "^4.17.1",
+		"zod": "^3.21.4"
+	}
+}

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "lib": ["es5", "es6"],
+    "target": "esnext",
+    "allowJs": true,
+    "esModuleInterop": true,
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "skipLibCheck": true,
+    "skipDefaultLibCheck": true,
+    "declaration": false,
+    "sourceMap": false,
+    "outDir": "./dist",
+    "rootDir": "src",
+    "baseUrl": "src"
+  },
+  "include": ["src"],
+  "exclude": [
+    "**/__tests__",
+    "**/__fixtures__",
+    "node_modules"
+  ]
+}

package/tsconfig.spec.json

@@ -0,0 +1,5 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src"],
+  "exclude": ["dist", "node_modules"]
+}