medusa-product-helper 0.0.16 → 0.0.19

package/.medusa/server/src/providers/filter-providers/rating-provider.js

@@ -2,86 +2,63 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RatingFilterProvider = void 0;
 const base_filter_provider_1 = require("./base-filter-provider");
-/**
- * Filter provider for filtering products by rating.
- *
- * Handles rating filtering with min/max values. Only applies
- * if rating is enabled in plugin options. Requires reviews
- * if configured.
- *
- * @example
- * ```ts
- * { rating: { min: 4, max: 5, require_reviews: true } }
- * ```
- */
 class RatingFilterProvider extends base_filter_provider_1.BaseFilterProvider {
     apply(filters, value, context) {
-        // Check if rating is enabled
-        if (!context?.options?.rating?.enabled) {
+        if (!this.isRatingEnabled(context))
             return filters;
-        }
-        if (!value || typeof value !== "object" || Array.isArray(value)) {
+        if (!this.isValidInput(value))
             return filters;
-        }
-        const rating = value;
-        // Get defaults from options
-        const min = rating.min !== undefined
-            ? rating.min
-            : context.options.rating.min ?? 0;
-        const max = rating.max !== undefined
-            ? rating.max
-            : context.options.rating.max ?? 5;
-        const requireReviews = rating.require_reviews !== undefined
-            ? rating.require_reviews
-            : context.options.rating.require_reviews ?? false;
-        // Build rating filter
-        // Note: Medusa's RemoteQuery doesn't support comparison operators ($gt, $lt, etc.)
-        // We can only filter by exact values or use post-query filtering for ranges
-        // For rating range filtering, we need to:
-        // 1. Filter products that have reviews (if requireReviews is true)
-        // 2. Calculate average_rating post-query and filter by range
-        const ratingFilters = {};
-        if (requireReviews) {
-            // Filter products that have at least one review
-            // Since we can't use $gt, we'll filter for products with count > 0
-            // This is a limitation - exact filtering requires post-query processing
-            // For now, we'll skip this filter and handle it post-query
-            console.warn(`[RatingFilterProvider] Rating range filtering (min: ${min}, max: ${max}) ` +
-                `requires post-query filtering. Medusa's query system doesn't support comparison operators.`);
-        }
-        // Note: Rating range filtering (min/max) requires:
-        // 1. Fetching products with total_rating_count and total_rating_sum
-        // 2. Calculating average_rating = total_rating_sum / total_rating_count
-        // 3. Filtering results post-query by the calculated average
-        // Return filters unchanged - rating filtering will be handled post-query
-        // This is a known limitation of Medusa's query system
-        return filters;
+        const input = value;
+        const { min, max, requireReviews } = this.getRatingCriteria(input, context);
+        // Rating range filtering requires post-query processing
+        // because Medusa's RemoteQuery doesn't support comparison operators
+        this.logRatingWarning(min, max, requireReviews);
+        return filters; // Filtering will be handled post-query
     }
     validate(value) {
-        if (value === undefined || value === null) {
+        if (value == null)
             return;
-        }
-        if (typeof value !== "object" || Array.isArray(value)) {
+        if (!this.isValidInput(value)) {
             throw new Error("rating must be an object with min and/or max");
         }
-        const rating = value;
-        if (rating.min !== undefined) {
-            if (typeof rating.min !== "number" || rating.min < 0 || rating.min > 5) {
-                throw new Error("rating.min must be a number between 0 and 5");
-            }
+        const input = value;
+        this.validateRange(input.min, "min", 0, 5);
+        this.validateRange(input.max, "max", 0, 5);
+        if (input.min !== undefined && input.max !== undefined && input.min > input.max) {
+            throw new Error("rating.min must be ≤ rating.max");
         }
-        if (rating.max !== undefined) {
-            if (typeof rating.max !== "number" || rating.max < 0 || rating.max > 5) {
-                throw new Error("rating.max must be a number between 0 and 5");
-            }
-        }
-        if (rating.min !== undefined && rating.max !== undefined && rating.min > rating.max) {
-            throw new Error("rating.min must be less than or equal to rating.max");
+        this.validateBoolean(input.require_reviews, "require_reviews");
+    }
+    isRatingEnabled(context) {
+        return context?.options?.rating?.enabled === true;
+    }
+    isValidInput(value) {
+        return value != null && typeof value === "object" && !Array.isArray(value);
+    }
+    getRatingCriteria(input, context) {
+        const ratingOptions = context.options.rating;
+        return {
+            min: input.min ?? ratingOptions.min ?? 0,
+            max: input.max ?? ratingOptions.max ?? 5,
+            requireReviews: input.require_reviews ?? ratingOptions.require_reviews ?? false
+        };
+    }
+    logRatingWarning(min, max, requireReviews) {
+        console.warn(`[RatingFilterProvider] Rating range filtering (min: ${min}, max: ${max}) ` +
+            `requires post-query filtering. Medusa's query system doesn't support comparison operators.`);
+    }
+    validateRange(value, field, minRange, maxRange) {
+        if (value === undefined)
+            return;
+        if (typeof value !== "number" || value < minRange || value > maxRange) {
+            throw new Error(`rating.${field} must be a number between ${minRange} and ${maxRange}`);
         }
-        if (rating.require_reviews !== undefined) {
-            if (typeof rating.require_reviews !== "boolean") {
-                throw new Error("rating.require_reviews must be a boolean");
-            }
+    }
+    validateBoolean(value, field) {
+        if (value === undefined)
+            return;
+        if (typeof value !== "boolean") {
+            throw new Error(`rating.${field} must be a boolean`);
         }
     }
 }
@@ -89,4 +66,4 @@ exports.RatingFilterProvider = RatingFilterProvider;
 RatingFilterProvider.identifier = "rating";
 RatingFilterProvider.displayName = "Rating Filter";
 RatingFilterProvider.description = "Filters products by rating (min/max)";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmF0aW5nLXByb3ZpZGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vc3JjL3Byb3ZpZGVycy9maWx0ZXItcHJvdmlkZXJzL3JhdGluZy1wcm92aWRlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSxpRUFBK0U7QUFFL0U7Ozs7Ozs7Ozs7O0dBV0c7QUFDSCxNQUFhLG9CQUFxQixTQUFRLHlDQUFrQjtJQUsxRCxLQUFLLENBQ0gsT0FBZ0MsRUFDaEMsS0FBYyxFQUNkLE9BQXVCO1FBRXZCLDZCQUE2QjtRQUM3QixJQUFJLENBQUMsT0FBTyxFQUFFLE9BQU8sRUFBRSxNQUFNLEVBQUUsT0FBTyxFQUFFLENBQUM7WUFDdkMsT0FBTyxPQUFPLENBQUE7UUFDaEIsQ0FBQztRQUVELElBQUksQ0FBQyxLQUFLLElBQUksT0FBTyxLQUFLLEtBQUssUUFBUSxJQUFJLEtBQUssQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQztZQUNoRSxPQUFPLE9BQU8sQ0FBQTtRQUNoQixDQUFDO1FBRUQsTUFBTSxNQUFNLEdBQUcsS0FJZCxDQUFBO1FBRUQsNEJBQTRCO1FBQzVCLE1BQU0sR0FBRyxHQUNQLE1BQU0sQ0FBQyxHQUFHLEtBQUssU0FBUztZQUN0QixDQUFDLENBQUMsTUFBTSxDQUFDLEdBQUc7WUFDWixDQUFDLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsR0FBRyxJQUFJLENBQUMsQ0FBQTtRQUVyQyxNQUFNLEdBQUcsR0FDUCxNQUFNLENBQUMsR0FBRyxLQUFLLFNBQVM7WUFDdEIsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxHQUFHO1lBQ1osQ0FBQyxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLEdBQUcsSUFBSSxDQUFDLENBQUE7UUFFckMsTUFBTSxjQUFjLEdBQ2xCLE1BQU0sQ0FBQyxlQUFlLEtBQUssU0FBUztZQUNsQyxDQUFDLENBQUMsTUFBTSxDQUFDLGVBQWU7WUFDeEIsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLGVBQWUsSUFBSSxLQUFLLENBQUE7UUFFckQsc0JBQXNCO1FBQ3RCLG1GQUFtRjtRQUNuRiw0RUFBNEU7UUFFNUUsMENBQTBDO1FBQzFDLG1FQUFtRTtRQUNuRSw2REFBNkQ7UUFFN0QsTUFBTSxhQUFhLEdBQTRCLEVBQUUsQ0FBQTtRQUVqRCxJQUFJLGNBQWMsRUFBRSxDQUFDO1lBQ25CLGdEQUFnRDtZQUNoRCxtRUFBbUU7WUFDbkUsd0VBQXdFO1lBQ3hFLDJEQUEyRDtZQUMzRCxPQUFPLENBQUMsSUFBSSxDQUNWLHVEQUF1RCxHQUFHLFVBQVUsR0FBRyxJQUFJO2dCQUMzRSw0RkFBNEYsQ0FDN0YsQ0FBQTtRQUNILENBQUM7UUFFRCxtREFBbUQ7UUFDbkQsb0VBQW9FO1FBQ3BFLHdFQUF3RTtRQUN4RSw0REFBNEQ7UUFFNUQseUVBQXlFO1FBQ3pFLHNEQUFzRDtRQUN0RCxPQUFPLE9BQU8sQ0FBQTtJQUNoQixDQUFDO0lBRUQsUUFBUSxDQUFDLEtBQWM7UUFDckIsSUFBSSxLQUFLLEtBQUssU0FBUyxJQUFJLEtBQUssS0FBSyxJQUFJLEVBQUUsQ0FBQztZQUMxQyxPQUFNO1FBQ1IsQ0FBQztRQUVELElBQUksT0FBTyxLQUFLLEtBQUssUUFBUSxJQUFJLEtBQUssQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQztZQUN0RCxNQUFNLElBQUksS0FBSyxDQUFDLDhDQUE4QyxDQUFDLENBQUE7UUFDakUsQ0FBQztRQUVELE1BQU0sTUFBTSxHQUFHLEtBSWQsQ0FBQTtRQUVELElBQUksTUFBTSxDQUFDLEdBQUcsS0FBSyxTQUFTLEVBQUUsQ0FBQztZQUM3QixJQUFJLE9BQU8sTUFBTSxDQUFDLEdBQUcsS0FBSyxRQUFRLElBQUksTUFBTSxDQUFDLEdBQUcsR0FBRyxDQUFDLElBQUksTUFBTSxDQUFDLEdBQUcsR0FBRyxDQUFDLEVBQUUsQ0FBQztnQkFDdkUsTUFBTSxJQUFJLEtBQUssQ0FBQyw2Q0FBNkMsQ0FBQyxDQUFBO1lBQ2hFLENBQUM7UUFDSCxDQUFDO1FBRUQsSUFBSSxNQUFNLENBQUMsR0FBRyxLQUFLLFNBQVMsRUFBRSxDQUFDO1lBQzdCLElBQUksT0FBTyxNQUFNLENBQUMsR0FBRyxLQUFLLFFBQVEsSUFBSSxNQUFNLENBQUMsR0FBRyxHQUFHLENBQUMsSUFBSSxNQUFNLENBQUMsR0FBRyxHQUFHLENBQUMsRUFBRSxDQUFDO2dCQUN2RSxNQUFNLElBQUksS0FBSyxDQUFDLDZDQUE2QyxDQUFDLENBQUE7WUFDaEUsQ0FBQztRQUNILENBQUM7UUFFRCxJQUFJLE1BQU0sQ0FBQyxHQUFHLEtBQUssU0FBUyxJQUFJLE1BQU0sQ0FBQyxHQUFHLEtBQUssU0FBUyxJQUFJLE1BQU0sQ0FBQyxHQUFHLEdBQUcsTUFBTSxDQUFDLEdBQUcsRUFBRSxDQUFDO1lBQ3BGLE1BQU0sSUFBSSxLQUFLLENBQUMscURBQXFELENBQUMsQ0FBQTtRQUN4RSxDQUFDO1FBRUQsSUFBSSxNQUFNLENBQUMsZUFBZSxLQUFLLFNBQVMsRUFBRSxDQUFDO1lBQ3pDLElBQUksT0FBTyxNQUFNLENBQUMsZUFBZSxLQUFLLFNBQVMsRUFBRSxDQUFDO2dCQUNoRCxNQUFNLElBQUksS0FBSyxDQUFDLDBDQUEwQyxDQUFDLENBQUE7WUFDN0QsQ0FBQztRQUNILENBQUM7SUFDSCxDQUFDOztBQTVHSCxvREE2R0M7QUE1R2lCLCtCQUFVLEdBQUcsUUFBUSxDQUFBO0FBQ3JCLGdDQUFXLEdBQUcsZUFBZSxDQUFBO0FBQzdCLGdDQUFXLEdBQUcsc0NBQXNDLENBQUEifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmF0aW5nLXByb3ZpZGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vc3JjL3Byb3ZpZGVycy9maWx0ZXItcHJvdmlkZXJzL3JhdGluZy1wcm92aWRlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSxpRUFBK0U7QUFRL0UsTUFBYSxvQkFBcUIsU0FBUSx5Q0FBa0I7SUFLMUQsS0FBSyxDQUFDLE9BQWdDLEVBQUUsS0FBYyxFQUFFLE9BQXVCO1FBQzdFLElBQUksQ0FBQyxJQUFJLENBQUMsZUFBZSxDQUFDLE9BQU8sQ0FBQztZQUFFLE9BQU8sT0FBTyxDQUFBO1FBQ2xELElBQUksQ0FBQyxJQUFJLENBQUMsWUFBWSxDQUFDLEtBQUssQ0FBQztZQUFFLE9BQU8sT0FBTyxDQUFBO1FBRTdDLE1BQU0sS0FBSyxHQUFHLEtBQW9CLENBQUE7UUFDbEMsTUFBTSxFQUFFLEdBQUcsRUFBRSxHQUFHLEVBQUUsY0FBYyxFQUFFLEdBQUcsSUFBSSxDQUFDLGlCQUFpQixDQUFDLEtBQUssRUFBRSxPQUFRLENBQUMsQ0FBQTtRQUU1RSx3REFBd0Q7UUFDeEQsb0VBQW9FO1FBQ3BFLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxHQUFHLEVBQUUsR0FBRyxFQUFFLGNBQWMsQ0FBQyxDQUFBO1FBRS9DLE9BQU8sT0FBTyxDQUFBLENBQUMsdUNBQXVDO0lBQ3hELENBQUM7SUFFRCxRQUFRLENBQUMsS0FBYztRQUNyQixJQUFJLEtBQUssSUFBSSxJQUFJO1lBQUUsT0FBTTtRQUV6QixJQUFJLENBQUMsSUFBSSxDQUFDLFlBQVksQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDO1lBQzlCLE1BQU0sSUFBSSxLQUFLLENBQUMsOENBQThDLENBQUMsQ0FBQTtRQUNqRSxDQUFDO1FBRUQsTUFBTSxLQUFLLEdBQUcsS0FBb0IsQ0FBQTtRQUVsQyxJQUFJLENBQUMsYUFBYSxDQUFDLEtBQUssQ0FBQyxHQUFHLEVBQUUsS0FBSyxFQUFFLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQTtRQUMxQyxJQUFJLENBQUMsYUFBYSxDQUFDLEtBQUssQ0FBQyxHQUFHLEVBQUUsS0FBSyxFQUFFLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQTtRQUUxQyxJQUFJLEtBQUssQ0FBQyxHQUFHLEtBQUssU0FBUyxJQUFJLEtBQUssQ0FBQyxHQUFHLEtBQUssU0FBUyxJQUFJLEtBQUssQ0FBQyxHQUFHLEdBQUcsS0FBSyxDQUFDLEdBQUcsRUFBRSxDQUFDO1lBQ2hGLE1BQU0sSUFBSSxLQUFLLENBQUMsaUNBQWlDLENBQUMsQ0FBQTtRQUNwRCxDQUFDO1FBRUQsSUFBSSxDQUFDLGVBQWUsQ0FBQyxLQUFLLENBQUMsZUFBZSxFQUFFLGlCQUFpQixDQUFDLENBQUE7SUFDaEUsQ0FBQztJQUVPLGVBQWUsQ0FBQyxPQUF1QjtRQUM3QyxPQUFPLE9BQU8sRUFBRSxPQUFPLEVBQUUsTUFBTSxFQUFFLE9BQU8sS0FBSyxJQUFJLENBQUE7SUFDbkQsQ0FBQztJQUVPLFlBQVksQ0FBQyxLQUFjO1FBQ2pDLE9BQU8sS0FBSyxJQUFJLElBQUksSUFBSSxPQUFPLEtBQUssS0FBSyxRQUFRLElBQUksQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxDQUFBO0lBQzVFLENBQUM7SUFFTyxpQkFBaUIsQ0FBQyxLQUFrQixFQUFFLE9BQXNCO1FBQ2xFLE1BQU0sYUFBYSxHQUFHLE9BQU8sQ0FBQyxPQUFRLENBQUMsTUFBTyxDQUFBO1FBRTlDLE9BQU87WUFDTCxHQUFHLEVBQUUsS0FBSyxDQUFDLEdBQUcsSUFBSSxhQUFhLENBQUMsR0FBRyxJQUFJLENBQUM7WUFDeEMsR0FBRyxFQUFFLEtBQUssQ0FBQyxHQUFHLElBQUksYUFBYSxDQUFDLEdBQUcsSUFBSSxDQUFDO1lBQ3hDLGNBQWMsRUFBRSxLQUFLLENBQUMsZUFBZSxJQUFJLGFBQWEsQ0FBQyxlQUFlLElBQUksS0FBSztTQUNoRixDQUFBO0lBQ0gsQ0FBQztJQUVPLGdCQUFnQixDQUFDLEdBQVcsRUFBRSxHQUFXLEVBQUUsY0FBdUI7UUFDeEUsT0FBTyxDQUFDLElBQUksQ0FDVix1REFBdUQsR0FBRyxVQUFVLEdBQUcsSUFBSTtZQUMzRSw0RkFBNEYsQ0FDN0YsQ0FBQTtJQUNILENBQUM7SUFFTyxhQUFhLENBQUMsS0FBYyxFQUFFLEtBQWEsRUFBRSxRQUFnQixFQUFFLFFBQWdCO1FBQ3JGLElBQUksS0FBSyxLQUFLLFNBQVM7WUFBRSxPQUFNO1FBRS9CLElBQUksT0FBTyxLQUFLLEtBQUssUUFBUSxJQUFJLEtBQUssR0FBRyxRQUFRLElBQUksS0FBSyxHQUFHLFFBQVEsRUFBRSxDQUFDO1lBQ3RFLE1BQU0sSUFBSSxLQUFLLENBQUMsVUFBVSxLQUFLLDZCQUE2QixRQUFRLFFBQVEsUUFBUSxFQUFFLENBQUMsQ0FBQTtRQUN6RixDQUFDO0lBQ0gsQ0FBQztJQUVPLGVBQWUsQ0FBQyxLQUFjLEVBQUUsS0FBYTtRQUNuRCxJQUFJLEtBQUssS0FBSyxTQUFTO1lBQUUsT0FBTTtRQUUvQixJQUFJLE9BQU8sS0FBSyxLQUFLLFNBQVMsRUFBRSxDQUFDO1lBQy9CLE1BQU0sSUFBSSxLQUFLLENBQUMsVUFBVSxLQUFLLG9CQUFvQixDQUFDLENBQUE7UUFDdEQsQ0FBQztJQUNILENBQUM7O0FBN0VILG9EQThFQztBQTdFaUIsK0JBQVUsR0FBRyxRQUFRLENBQUE7QUFDckIsZ0NBQVcsR0FBRyxlQUFlLENBQUE7QUFDN0IsZ0NBQVcsR0FBRyxzQ0FBc0MsQ0FBQSJ9