@shopgate/pwa-common-commerce 7.34.0-beta.1 → 7.34.0-beta.2

package/reviews/action-creators/receiveReviewVote.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"receiveReviewVote.d.ts","sourceRoot":"","sources":["../../../reviews/action-creators/receiveReviewVote.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,KAAK,EAAE,QAAQ,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE/E;;;;;;GAMG;AACH,QAAA,MAAM,iBAAiB,GACrB,UAAU,QAAQ,EAClB,MAAM,UAAU,EAChB,aAAa,gBAAgB;UAEA,OAAO,mBAAmB;;;;CAIvD,CAAC;AAEH,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE3E,eAAe,iBAAiB,CAAC"}

package/reviews/action-creators/receiveReviewVote.js

@@ -0,0 +1,15 @@
+import { RECEIVE_REVIEW_VOTE } from "../constants";
+/**
+ * Dispatches the RECEIVE_REVIEW_VOTE action.
+ * @param reviewId The ID of the review that was voted on.
+ * @param vote The vote of the user.
+ * @param reviewVotes The vote counts of the review after the vote.
+ * @returns The RECEIVE_REVIEW_VOTE action.
+ */
+const receiveReviewVote = (reviewId, vote, reviewVotes) => ({
+  type: RECEIVE_REVIEW_VOTE,
+  reviewId,
+  vote,
+  reviewVotes
+});
+export default receiveReviewVote;

package/reviews/action-creators/receiveReviews.d.ts

@@ -0,0 +1,29 @@
+import { RECEIVE_REVIEWS } from '../constants';
+import type { Review, ReviewsRequestMeta } from '../types/reviews';
+/**
+ * Dispatches the RECEIVE_REVIEWS action.
+ * @param hash Generated hash for an entity.
+ * @param productId The ID of the product.
+ * @param reviews The received review data.
+ * @param totalReviewCount The total number of reviews for a product.
+ * @param meta Request metadata.
+ * @param after The cursor for the next page as returned by the pipeline.
+ * @param summary The rating summary as returned by the pipeline.
+ * @returns The RECEIVE_PRODUCT_REVIEWS action.
+ */
+declare const receiveReviews: (hash: string, productId: string, reviews: Review[], totalReviewCount?: number | null, meta?: ReviewsRequestMeta, after?: string | null, summary?: unknown) => {
+    type: typeof RECEIVE_REVIEWS;
+    hash: string;
+    productId: string;
+    reviews: Review[];
+    totalReviewCount: number | null | undefined;
+    after: string | null | undefined;
+    summary: unknown;
+    requestId?: number;
+    offset?: number;
+    sort?: string;
+    filters?: import("../types/reviews").ReviewListFilters;
+};
+export type ReceiveReviewsAction = ReturnType<typeof receiveReviews>;
+export default receiveReviews;
+//# sourceMappingURL=receiveReviews.d.ts.map

package/reviews/action-creators/receiveReviews.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"receiveReviews.d.ts","sourceRoot":"","sources":["../../../reviews/action-creators/receiveReviews.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEnE;;;;;;;;;;GAUG;AACH,QAAA,MAAM,cAAc,GAClB,MAAM,MAAM,EACZ,WAAW,MAAM,EACjB,SAAS,MAAM,EAAE,EACjB,mBAAmB,MAAM,GAAG,IAAI,EAChC,OAAM,kBAAuB,EAC7B,QAAQ,MAAM,GAAG,IAAI,EACrB,UAAU,OAAO;UAGQ,OAAO,eAAe;;;;;;;;;;;CAO/C,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AAErE,eAAe,cAAc,CAAC"}

package/reviews/action-creators/receiveReviews.js

@@ -1,18 +1,23 @@
 import { RECEIVE_REVIEWS } from "../constants";
-
 /**
  * Dispatches the RECEIVE_REVIEWS action.
- * @param {string} hash Generated hash for an entity.
- * @param {string} productId The ID of the product.
- * @param {Array} reviews The received review data.
- * @param {number} totalReviewCount The total number of reviews for a product.
- * @returns {Object} The RECEIVE_PRODUCT_REVIEWS action.
+ * @param hash Generated hash for an entity.
+ * @param productId The ID of the product.
+ * @param reviews The received review data.
+ * @param totalReviewCount The total number of reviews for a product.
+ * @param meta Request metadata.
+ * @param after The cursor for the next page as returned by the pipeline.
+ * @param summary The rating summary as returned by the pipeline.
+ * @returns The RECEIVE_PRODUCT_REVIEWS action.
  */
-const receiveReviews = (hash, productId, reviews, totalReviewCount) => ({
+const receiveReviews = (hash, productId, reviews, totalReviewCount, meta = {}, after, summary) => ({
+  ...meta,
   type: RECEIVE_REVIEWS,
   hash,
   productId,
   reviews,
-  totalReviewCount
+  totalReviewCount,
+  after,
+  summary
 });
 export default receiveReviews;

package/reviews/action-creators/requestProductReviews.d.ts

@@ -0,0 +1,21 @@
+import { REQUEST_PRODUCT_REVIEWS } from '../constants';
+import type { ReviewsRequestMeta } from '../types/reviews';
+/**
+ * Dispatches the REQUEST_PRODUCT_REVIEWS action.
+ * @param productId The ID of the product
+ * @param limit The maximum number of reviews
+ * @param meta Request metadata.
+ * @returns The REQUEST_PRODUCT_REVIEWS action
+ */
+declare const requestProductReviews: (productId: string, limit: number, meta?: ReviewsRequestMeta) => {
+    type: typeof REQUEST_PRODUCT_REVIEWS;
+    productId: string;
+    limit: number;
+    requestId?: number;
+    offset?: number;
+    sort?: string;
+    filters?: import("../types/reviews").ReviewListFilters;
+};
+export type RequestProductReviewsAction = ReturnType<typeof requestProductReviews>;
+export default requestProductReviews;
+//# sourceMappingURL=requestProductReviews.d.ts.map

package/reviews/action-creators/requestProductReviews.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requestProductReviews.d.ts","sourceRoot":"","sources":["../../../reviews/action-creators/requestProductReviews.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AACvD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAE3D;;;;;;GAMG;AACH,QAAA,MAAM,qBAAqB,GACzB,WAAW,MAAM,EACjB,OAAO,MAAM,EACb,OAAM,kBAAuB;UAGI,OAAO,uBAAuB;;;;;;;CAG/D,CAAC;AAEH,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEnF,eAAe,qBAAqB,CAAC"}

package/reviews/action-creators/requestProductReviews.js

@@ -1,12 +1,13 @@
 import { REQUEST_PRODUCT_REVIEWS } from "../constants";
-
 /**
  * Dispatches the REQUEST_PRODUCT_REVIEWS action.
- * @param {string} productId The ID of the product
- * @param {number} limit The maximum number of reviews
- * @returns {Object} The REQUEST_PRODUCT_REVIEWS action
+ * @param productId The ID of the product
+ * @param limit The maximum number of reviews
+ * @param meta Request metadata.
+ * @returns The REQUEST_PRODUCT_REVIEWS action
  */
-const requestProductReviews = (productId, limit) => ({
+const requestProductReviews = (productId, limit, meta = {}) => ({
+  ...meta,
   type: REQUEST_PRODUCT_REVIEWS,
   productId,
   limit

package/reviews/action-creators/requestReviews.d.ts

@@ -0,0 +1,19 @@
+import { REQUEST_REVIEWS } from '../constants';
+import type { ReviewsRequestMeta } from '../types/reviews';
+/**
+ * Dispatches the REQUEST_REVIEWS action.
+ * @param hash Generated hash.
+ * @param meta Request metadata.
+ * @returns The REQUEST_PRODUCT_REVIEWS action.
+ */
+declare const requestReviews: (hash: string, meta?: ReviewsRequestMeta) => {
+    type: typeof REQUEST_REVIEWS;
+    hash: string;
+    requestId?: number;
+    offset?: number;
+    sort?: string;
+    filters?: import("../types/reviews").ReviewListFilters;
+};
+export type RequestReviewsAction = ReturnType<typeof requestReviews>;
+export default requestReviews;
+//# sourceMappingURL=requestReviews.d.ts.map

package/reviews/action-creators/requestReviews.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requestReviews.d.ts","sourceRoot":"","sources":["../../../reviews/action-creators/requestReviews.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAE3D;;;;;GAKG;AACH,QAAA,MAAM,cAAc,GAAI,MAAM,MAAM,EAAE,OAAM,kBAAuB;UAExC,OAAO,eAAe;;;;;;CAE/C,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AAErE,eAAe,cAAc,CAAC"}

package/reviews/action-creators/requestReviews.js

@@ -1,11 +1,12 @@
 import { REQUEST_REVIEWS } from "../constants";
-
 /**
  * Dispatches the REQUEST_REVIEWS action.
- * @param {string} hash Generated hash.
- * @returns {Object} The REQUEST_PRODUCT_REVIEWS action.
+ * @param hash Generated hash.
+ * @param meta Request metadata.
+ * @returns The REQUEST_PRODUCT_REVIEWS action.
  */
-const requestReviews = hash => ({
+const requestReviews = (hash, meta = {}) => ({
+  ...meta,
   type: REQUEST_REVIEWS,
   hash
 });

package/reviews/action-creators/reviewSettings.d.ts

@@ -0,0 +1,31 @@
+import { REQUEST_PRODUCT_REVIEW_SETTINGS, RECEIVE_PRODUCT_REVIEW_SETTINGS, ERROR_PRODUCT_REVIEW_SETTINGS } from '../constants';
+import type { ReviewSettings } from '../types/reviewSettings';
+/**
+ * Creates the REQUEST_PRODUCT_REVIEW_SETTINGS action.
+ * @returns The dispatched action.
+ */
+export declare const requestProductReviewSettings: () => {
+    type: typeof REQUEST_PRODUCT_REVIEW_SETTINGS;
+};
+/**
+ * Creates the RECEIVE_PRODUCT_REVIEW_SETTINGS action.
+ * @param settings The review settings returned by the pipeline.
+ * @returns The dispatched action.
+ */
+export declare const receiveProductReviewSettings: (settings: ReviewSettings) => {
+    type: typeof RECEIVE_PRODUCT_REVIEW_SETTINGS;
+    settings: ReviewSettings;
+};
+/**
+ * Creates the ERROR_PRODUCT_REVIEW_SETTINGS action.
+ * @param error The error that occurred while requesting the settings.
+ * @returns The dispatched action.
+ */
+export declare const errorProductReviewSettings: (error: unknown) => {
+    type: typeof ERROR_PRODUCT_REVIEW_SETTINGS;
+    error: unknown;
+};
+export type RequestProductReviewSettingsAction = ReturnType<typeof requestProductReviewSettings>;
+export type ReceiveProductReviewSettingsAction = ReturnType<typeof receiveProductReviewSettings>;
+export type ErrorProductReviewSettingsAction = ReturnType<typeof errorProductReviewSettings>;
+//# sourceMappingURL=reviewSettings.d.ts.map

package/reviews/action-creators/reviewSettings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reviewSettings.d.ts","sourceRoot":"","sources":["../../../reviews/action-creators/reviewSettings.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,+BAA+B,EAC/B,+BAA+B,EAC/B,6BAA6B,EAC9B,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAE9D;;;GAGG;AACH,eAAO,MAAM,4BAA4B;UACE,OAAO,+BAA+B;CAC/E,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,4BAA4B,GAAI,UAAU,cAAc;UAC1B,OAAO,+BAA+B;;CAE/E,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,GAAI,OAAO,OAAO;UAChB,OAAO,6BAA6B;;CAE3E,CAAC;AAEH,MAAM,MAAM,kCAAkC,GAAG,UAAU,CAAC,OAAO,4BAA4B,CAAC,CAAC;AACjG,MAAM,MAAM,kCAAkC,GAAG,UAAU,CAAC,OAAO,4BAA4B,CAAC,CAAC;AACjG,MAAM,MAAM,gCAAgC,GAAG,UAAU,CAAC,OAAO,0BAA0B,CAAC,CAAC"}

package/reviews/action-creators/reviewSettings.js

@@ -0,0 +1,28 @@
+import { REQUEST_PRODUCT_REVIEW_SETTINGS, RECEIVE_PRODUCT_REVIEW_SETTINGS, ERROR_PRODUCT_REVIEW_SETTINGS } from "../constants";
+/**
+ * Creates the REQUEST_PRODUCT_REVIEW_SETTINGS action.
+ * @returns The dispatched action.
+ */
+export const requestProductReviewSettings = () => ({
+  type: REQUEST_PRODUCT_REVIEW_SETTINGS
+});
+
+/**
+ * Creates the RECEIVE_PRODUCT_REVIEW_SETTINGS action.
+ * @param settings The review settings returned by the pipeline.
+ * @returns The dispatched action.
+ */
+export const receiveProductReviewSettings = settings => ({
+  type: RECEIVE_PRODUCT_REVIEW_SETTINGS,
+  settings
+});
+
+/**
+ * Creates the ERROR_PRODUCT_REVIEW_SETTINGS action.
+ * @param error The error that occurred while requesting the settings.
+ * @returns The dispatched action.
+ */
+export const errorProductReviewSettings = error => ({
+  type: ERROR_PRODUCT_REVIEW_SETTINGS,
+  error
+});

package/reviews/actions/fetchProductReviewSettings.d.ts

@@ -0,0 +1,5 @@
+import type { Dispatch } from 'redux';
+import type { ReviewSettingsState } from '../types/reviewSettings';
+declare const _default: () => (dispatch: Dispatch, getState: () => ReviewSettingsState) => Promise<any>;
+export default _default;
+//# sourceMappingURL=fetchProductReviewSettings.d.ts.map

package/reviews/actions/fetchProductReviewSettings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchProductReviewSettings.d.ts","sourceRoot":"","sources":["../../../reviews/actions/fetchProductReviewSettings.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAQtC,OAAO,KAAK,EAAkB,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;+BAQjF,UAAU,QAAQ,EAClB,UAAU,MAAM,mBAAmB;AAuBrC,wBAAmD"}

package/reviews/actions/fetchProductReviewSettings.js

@@ -0,0 +1,25 @@
+import PipelineRequest from '@shopgate/pwa-core/classes/PipelineRequest';
+import { shouldFetchData, mutable } from '@shopgate/pwa-common/helpers/redux';
+import { requestProductReviewSettings, receiveProductReviewSettings, errorProductReviewSettings } from "../action-creators/reviewSettings";
+import { getReviewSettingsState } from "../selectors/reviewSettings";
+import { SHOPGATE_CATALOG_GET_PRODUCT_REVIEW_SETTINGS } from "../constants/Pipelines";
+/**
+ * Loads the product review settings and caches them in the reviews slice.
+ * Skips the request while a valid cached response exists or one is in flight.
+ * @returns A redux thunk resolving with the pipeline response or the cached settings.
+ */
+const fetchProductReviewSettings = () => (dispatch, getState) => {
+  const settings = getReviewSettingsState(getState());
+  if (!shouldFetchData(settings)) {
+    return Promise.resolve(settings);
+  }
+  dispatch(requestProductReviewSettings());
+  const request = new PipelineRequest(SHOPGATE_CATALOG_GET_PRODUCT_REVIEW_SETTINGS).dispatch();
+  request.then(result => {
+    dispatch(receiveProductReviewSettings(result));
+  }).catch(error => {
+    dispatch(errorProductReviewSettings(error));
+  });
+  return request;
+};
+export default mutable(fetchProductReviewSettings);

package/reviews/actions/fetchProductReviews.d.ts

@@ -0,0 +1,17 @@
+import type { Dispatch } from 'redux';
+import type { ReviewsSliceState } from '../types/reviews';
+type FetchProductReviewsState = {
+    reviews: Pick<ReviewsSliceState, 'reviewsByProductId'>;
+};
+/**
+ * Request product reviews for a product from server.
+ * @param productId The product ID
+ * @param limit The maximum number of reviews to fetch
+ * @param sort Sorting, passed through to the pipeline unchanged.
+ * @returns The dispatched action.
+ */
+declare function fetchProductReviews(productId: string, limit?: number, sort?: string): (dispatch: Dispatch, getState: () => FetchProductReviewsState) => Promise<any>;
+/** @mixes {MutableFunction} */
+declare const _default: typeof fetchProductReviews;
+export default _default;
+//# sourceMappingURL=fetchProductReviews.d.ts.map

package/reviews/actions/fetchProductReviews.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchProductReviews.d.ts","sourceRoot":"","sources":["../../../reviews/actions/fetchProductReviews.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAMtC,OAAO,KAAK,EAEV,iBAAiB,EAClB,MAAM,kBAAkB,CAAC;AAE1B,KAAK,wBAAwB,GAAG;IAC9B,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,CAAC;CACxD,CAAC;AAIF;;;;;;GAMG;AACH,iBAAS,mBAAmB,CAC1B,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,MAA6B,EACpC,IAAI,GAAE,MAAuB,IAErB,UAAU,QAAQ,EAAE,UAAU,MAAM,wBAAwB,kBAkCrE;AAED,+BAA+B;;AAC/B,wBAA4C"}

package/reviews/actions/fetchProductReviews.js

@@ -1,4 +1,5 @@
 import PipelineRequest from '@shopgate/pwa-core/classes/PipelineRequest';
+import { ERROR_HANDLE_SUPPRESS } from '@shopgate/pwa-core/constants/ErrorHandleTypes';
 import { shouldFetchData, mutable } from '@shopgate/pwa-common/helpers/redux';
 import { SORT_RELEVANCE } from '@shopgate/pwa-common/constants/DisplayOptions';
 import { SHOPGATE_CATALOG_GET_PRODUCT_REVIEWS } from "../constants/Pipelines";
@@ -6,13 +7,14 @@ import { REVIEW_PREVIEW_COUNT } from "../constants";
 import requestProductReviews from "../action-creators/requestProductReviews";
 import receiveProductReviews from "../action-creators/receiveProductReviews";
 import errorProductReviews from "../action-creators/errorProductReviews";
+let lastRequestId = 0;
 
 /**
  * Request product reviews for a product from server.
- * @param {string} productId The product ID
- * @param {number} [limit=REVIEW_PREVIEW_COUNT] The maximum number of reviews to fetch
- * @param {('relevance'|'dateDesc'|'dateAsc'|'rateDesc'|'rateAsc')} [sort=SORT_RELEVANCE] Sorting.
- * @returns {Promise} The dispatched action.
+ * @param productId The product ID
+ * @param limit The maximum number of reviews to fetch
+ * @param sort Sorting, passed through to the pipeline unchanged.
+ * @returns The dispatched action.
  */
 function fetchProductReviews(productId, limit = REVIEW_PREVIEW_COUNT, sort = SORT_RELEVANCE) {
   return (dispatch, getState) => {
@@ -20,19 +22,25 @@ function fetchProductReviews(productId, limit = REVIEW_PREVIEW_COUNT, sort = SOR
     if (!shouldFetchData(data)) {
       return Promise.resolve(null);
     }
-    dispatch(requestProductReviews(productId, limit));
+    lastRequestId += 1;
+    const meta = {
+      requestId: lastRequestId,
+      sort
+    };
+    dispatch(requestProductReviews(productId, limit, meta));
     const request = new PipelineRequest(SHOPGATE_CATALOG_GET_PRODUCT_REVIEWS).setInput({
       productId,
       limit,
       sort
-    }).dispatch();
+    }).setHandleErrors(ERROR_HANDLE_SUPPRESS).dispatch();
     request.then(({
       reviews,
-      totalReviewCount
+      totalReviewCount,
+      ratingSummary
     }) => {
-      dispatch(receiveProductReviews(productId, reviews, totalReviewCount));
+      dispatch(receiveProductReviews(productId, reviews, totalReviewCount, meta, ratingSummary));
     }).catch(() => {
-      dispatch(errorProductReviews(productId));
+      dispatch(errorProductReviews(productId, meta));
     });
     return request;
   };

package/reviews/actions/fetchReviews.d.ts

@@ -0,0 +1,22 @@
+import type { Dispatch } from 'redux';
+import type { ReviewListFilterInput, ReviewsSliceState } from '../types/reviews';
+type FetchReviewsState = {
+    reviews: Pick<ReviewsSliceState, 'reviewsByHash' | 'reviewSettings'>;
+};
+/**
+ * Request product reviews for a product by the given id.
+ * @param productId The product ID.
+ * @param limit The maximum number of reviews to fetch.
+ * @param offset The list offset (defaults to 0). With cursor pagination any offset above 0 means
+ * "next page": the stored cursor is sent instead. Without a stored cursor for the requested
+ * sort and filter the first page is requested.
+ * @param sort Sorting, passed through to the pipeline unchanged.
+ * @param filters Filter values by request parameter; only active filters are sent.
+ * @returns The dispatched action. It resolves with `null` when an identical request
+ * is still in flight.
+ */
+declare function fetchReviews(productId: string, limit?: number, offset?: number, sort?: string, filters?: ReviewListFilterInput): (dispatch: Dispatch, getState: () => FetchReviewsState) => Promise<any>;
+/** @mixes {MutableFunction} */
+declare const _default: typeof fetchReviews;
+export default _default;
+//# sourceMappingURL=fetchReviews.d.ts.map

package/reviews/actions/fetchReviews.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchReviews.d.ts","sourceRoot":"","sources":["../../../reviews/actions/fetchReviews.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAQtC,OAAO,KAAK,EAEV,qBAAqB,EACrB,iBAAiB,EAClB,MAAM,kBAAkB,CAAC;AAE1B,KAAK,iBAAiB,GAAG;IACvB,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,eAAe,GAAG,gBAAgB,CAAC,CAAC;CACtE,CAAC;AAIF;;;;;;;;;;;GAWG;AACH,iBAAS,YAAY,CACnB,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,MAA6B,EACpC,MAAM,SAAI,EACV,IAAI,GAAE,MAAuB,EAC7B,OAAO,GAAE,qBAA0B,IAE3B,UAAU,QAAQ,EAAE,UAAU,MAAM,iBAAiB,kBAsE9D;AAED,+BAA+B;;AAC/B,wBAAqC"}

package/reviews/actions/fetchReviews.js

@@ -1,4 +1,5 @@
 import PipelineRequest from '@shopgate/pwa-core/classes/PipelineRequest';
+import { ERROR_HANDLE_SUPPRESS } from '@shopgate/pwa-core/constants/ErrorHandleTypes';
 import { SORT_DATE_DESC } from '@shopgate/pwa-common/constants/DisplayOptions';
 import { generateResultHash, mutable } from '@shopgate/pwa-common/helpers/redux';
 import { REVIEW_PREVIEW_COUNT } from "../constants";
@@ -6,35 +7,68 @@ import { SHOPGATE_CATALOG_GET_PRODUCT_REVIEWS } from "../constants/Pipelines";
 import requestProductReviewsList from "../action-creators/requestReviews";
 import receiveProductReviewsList from "../action-creators/receiveReviews";
 import errorProductReviewsList from "../action-creators/errorReviews";
+import { areReviewFiltersEqual, getActiveReviewFilters } from "../helpers/filters";
+import { isReviewCursorPagination } from "../selectors/reviewSettings";
+let lastRequestId = 0;
 
 /**
  * Request product reviews for a product by the given id.
- * @param {string} productId The product ID.
- * @param {number} [limit=REVIEW_PREVIEW_COUNT] The maximum number of reviews to fetch.
- * @param {number} [offset=0] The list offset (defaults to 0).
- * @param {('relevance'|'dateDesc'|'dateAsc'|'rateDesc'|'rateAsc')} sort Sorting.
- * @returns {Function} The dispatched action.
+ * @param productId The product ID.
+ * @param limit The maximum number of reviews to fetch.
+ * @param offset The list offset (defaults to 0). With cursor pagination any offset above 0 means
+ * "next page": the stored cursor is sent instead. Without a stored cursor for the requested
+ * sort and filter the first page is requested.
+ * @param sort Sorting, passed through to the pipeline unchanged.
+ * @param filters Filter values by request parameter; only active filters are sent.
+ * @returns The dispatched action. It resolves with `null` when an identical request
+ * is still in flight.
  */
-function fetchReviews(productId, limit = REVIEW_PREVIEW_COUNT, offset = 0, sort = SORT_DATE_DESC) {
-  return dispatch => {
+function fetchReviews(productId, limit = REVIEW_PREVIEW_COUNT, offset = 0, sort = SORT_DATE_DESC, filters = {}) {
+  return (dispatch, getState) => {
     const hash = generateResultHash({
       pipeline: SHOPGATE_CATALOG_GET_PRODUCT_REVIEWS,
       productId
     }, false);
-    dispatch(requestProductReviewsList(hash));
+    const activeFilters = getActiveReviewFilters(filters);
+    const state = getState();
+    const collection = state.reviews.reviewsByHash[hash];
+    const isCursor = isReviewCursorPagination(state);
+    const canContinue = isCursor && offset > 0 && collection?.sort === sort && areReviewFiltersEqual(collection.filters, activeFilters);
+    const after = canContinue && collection.after || null;
+    const requestOffset = isCursor && !after ? 0 : offset;
+    if (collection?.isFetching && collection.requestOffset === requestOffset && collection.requestSort === sort && areReviewFiltersEqual(collection.requestFilters, activeFilters)) {
+      return Promise.resolve(null);
+    }
+    lastRequestId += 1;
+    const meta = {
+      requestId: lastRequestId,
+      offset: requestOffset,
+      sort,
+      ...(activeFilters && {
+        filters: activeFilters
+      })
+    };
+    dispatch(requestProductReviewsList(hash, meta));
     const request = new PipelineRequest(SHOPGATE_CATALOG_GET_PRODUCT_REVIEWS).setInput({
       productId,
       limit,
-      offset,
-      sort
-    }).dispatch();
+      sort,
+      ...(after ? {
+        after
+      } : requestOffset > 0 && {
+        offset: requestOffset
+      }),
+      ...activeFilters
+    }).setHandleErrors(ERROR_HANDLE_SUPPRESS).dispatch();
     request.then(({
       reviews,
-      totalReviewCount
+      totalReviewCount,
+      cursors,
+      ratingSummary
     }) => {
-      dispatch(receiveProductReviewsList(hash, productId, reviews, totalReviewCount));
+      dispatch(receiveProductReviewsList(hash, productId, reviews, totalReviewCount, meta, cursors?.after, ratingSummary));
     }).catch(() => {
-      dispatch(errorProductReviewsList(hash));
+      dispatch(errorProductReviewsList(hash, meta));
     });
     return request;
   };

package/reviews/actions/submitReviewVote.d.ts

@@ -0,0 +1,15 @@
+import type { Dispatch } from 'redux';
+import type { ReviewId, ReviewsState, ReviewVote, OwnReviewVotesState } from '../types/reviews';
+type SubmitReviewVoteState = ReviewsState & OwnReviewVotesState;
+/**
+ * Submits a helpfulness vote for a review.
+ * @param reviewId The ID of the review.
+ * @param vote The vote of the user.
+ * @returns The dispatched action. It resolves with `null` when the user already voted on the
+ * review or a vote for it is still in flight.
+ */
+declare function submitReviewVote(reviewId: ReviewId, vote: ReviewVote): (dispatch: Dispatch, getState: () => SubmitReviewVoteState) => Promise<any>;
+/** @mixes {MutableFunction} */
+declare const _default: typeof submitReviewVote;
+export default _default;
+//# sourceMappingURL=submitReviewVote.d.ts.map

package/reviews/actions/submitReviewVote.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"submitReviewVote.d.ts","sourceRoot":"","sources":["../../../reviews/actions/submitReviewVote.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAItC,OAAO,KAAK,EACV,QAAQ,EAER,YAAY,EACZ,UAAU,EACV,mBAAmB,EACpB,MAAM,kBAAkB,CAAC;AAE1B,KAAK,qBAAqB,GAAG,YAAY,GAAG,mBAAmB,CAAC;AAIhE;;;;;;GAMG;AACH,iBAAS,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,IACpD,UAAU,QAAQ,EAAE,UAAU,MAAM,qBAAqB,kBAuClE;AAED,+BAA+B;;AAC/B,wBAAyC"}

package/reviews/actions/submitReviewVote.js

@@ -0,0 +1,46 @@
+import PipelineRequest from '@shopgate/pwa-core/classes/PipelineRequest';
+import { ERROR_HANDLE_SUPPRESS } from '@shopgate/pwa-core/constants/ErrorHandleTypes';
+import { mutable } from '@shopgate/pwa-common/helpers/redux';
+import { SHOPGATE_CATALOG_ADD_PRODUCT_REVIEW_VOTE } from "../constants/Pipelines";
+import receiveReviewVote from "../action-creators/receiveReviewVote";
+import { getReviews, getOwnReviewVote } from "../selectors";
+const pendingReviewIds = new Set();
+
+/**
+ * Submits a helpfulness vote for a review.
+ * @param reviewId The ID of the review.
+ * @param vote The vote of the user.
+ * @returns The dispatched action. It resolves with `null` when the user already voted on the
+ * review or a vote for it is still in flight.
+ */
+function submitReviewVote(reviewId, vote) {
+  return (dispatch, getState) => {
+    const key = String(reviewId);
+    if (pendingReviewIds.has(key) || getOwnReviewVote(getState(), reviewId)) {
+      return Promise.resolve(null);
+    }
+    pendingReviewIds.add(key);
+    const request = new PipelineRequest(SHOPGATE_CATALOG_ADD_PRODUCT_REVIEW_VOTE).setInput({
+      reviewId,
+      vote
+    }).setRetries(0).setHandleErrors(ERROR_HANDLE_SUPPRESS).dispatch();
+    request.then(result => {
+      pendingReviewIds.delete(key);
+      const current = getReviews(getState())[key]?.reviewVotes;
+      const hasCounts = typeof result?.up === 'number' && typeof result?.down === 'number';
+      dispatch(receiveReviewVote(reviewId, vote, hasCounts ? {
+        up: result.up,
+        down: result.down
+      } : {
+        ...current,
+        [vote]: (current?.[vote] ?? 0) + 1
+      }));
+    }).catch(() => {
+      pendingReviewIds.delete(key);
+    });
+    return request;
+  };
+}
+
+/** @mixes {MutableFunction} */
+export default mutable(submitReviewVote);

package/reviews/constants/Pipelines.d.ts

@@ -0,0 +1,7 @@
+export const SHOPGATE_CATALOG_GET_PRODUCT_REVIEWS: "shopgate.catalog.getProductReviews";
+export const SHOPGATE_CATALOG_GET_PRODUCT_REVIEW_SETTINGS: "shopgate.catalog.getProductReviewSettings";
+export const SHOPGATE_USER_GET_REVIEW: "shopgate.user.getReview";
+export const SHOPGATE_CATALOG_UPDATE_PRODUCT_REVIEW: "shopgate.catalog.updateProductReview";
+export const SHOPGATE_CATALOG_ADD_PRODUCT_REVIEW: "shopgate.catalog.addProductReview";
+export const SHOPGATE_CATALOG_ADD_PRODUCT_REVIEW_VOTE: "shopgate.catalog.addProductReviewVote";
+//# sourceMappingURL=Pipelines.d.ts.map

package/reviews/constants/Pipelines.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Pipelines.d.ts","sourceRoot":"","sources":["../../../reviews/constants/Pipelines.js"],"names":[],"mappings":"AAAA,mDAAoD,oCAAoC,CAAC;AACzF,2DAA4D,2CAA2C,CAAC;AACxG,uCAAwC,yBAAyB,CAAC;AAClE,qDAAsD,sCAAsC,CAAC;AAC7F,kDAAmD,mCAAmC,CAAC;AACvF,uDAAwD,uCAAuC,CAAC"}

package/reviews/constants/Pipelines.js

@@ -1,4 +1,6 @@
 export const SHOPGATE_CATALOG_GET_PRODUCT_REVIEWS = 'shopgate.catalog.getProductReviews';
+export const SHOPGATE_CATALOG_GET_PRODUCT_REVIEW_SETTINGS = 'shopgate.catalog.getProductReviewSettings';
 export const SHOPGATE_USER_GET_REVIEW = 'shopgate.user.getReview';
 export const SHOPGATE_CATALOG_UPDATE_PRODUCT_REVIEW = 'shopgate.catalog.updateProductReview';
-export const SHOPGATE_CATALOG_ADD_PRODUCT_REVIEW = 'shopgate.catalog.addProductReview';
+export const SHOPGATE_CATALOG_ADD_PRODUCT_REVIEW = 'shopgate.catalog.addProductReview';
+export const SHOPGATE_CATALOG_ADD_PRODUCT_REVIEW_VOTE = 'shopgate.catalog.addProductReviewVote';

package/reviews/constants/index.d.ts

@@ -0,0 +1,47 @@
+export const REVIEWS_LIFETIME: 900000;
+export const REQUEST_REVIEWS: "REQUEST_REVIEWS";
+export const RECEIVE_REVIEWS: "RECEIVE_REVIEWS";
+export const ERROR_REVIEWS: "ERROR_REVIEWS";
+export const REQUEST_PRODUCT_REVIEWS: "REQUEST_PRODUCT_REVIEWS";
+export const RECEIVE_PRODUCT_REVIEWS: "RECEIVE_PRODUCT_REVIEWS";
+export const ERROR_PRODUCT_REVIEWS: "ERROR_PRODUCT_REVIEWS";
+export const USER_REVIEW_LIFETIME: 300000;
+export const REQUEST_USER_REVIEW: "REQUEST_USER_REVIEW";
+export const RECEIVE_USER_REVIEW: "RECEIVE_USER_REVIEW";
+export const ERROR_USER_REVIEW: "ERROR_USER_REVIEW";
+export const FLUSH_USER_REVIEWS: "FLUSH_USER_REVIEWS";
+export const REQUEST_SUBMIT_REVIEW: "REQUEST_SUBMIT_REVIEW";
+export const RECEIVE_SUBMIT_REVIEW: "RECEIVE_SUBMIT_REVIEW";
+export const ERROR_SUBMIT_REVIEW: "ERROR_SUBMIT_REVIEW";
+export const RESET_SUBMIT_REVIEW: "RESET_SUBMIT_REVIEW";
+export const RECEIVE_REVIEW_VOTE: "RECEIVE_REVIEW_VOTE";
+export const REVIEW_FEATURE_VOTES: "reviewVotes";
+export const REVIEW_FEATURE_RATING_SUMMARY: "ratingSummary";
+/**
+ * The list filters the PWA knows: the request parameter that activates the filter, which a
+ * provider also reports as capability in its settings, the kind of its control and the label.
+ * A toggle is sent as `true`, the rate filter as the number of stars from 1 to 5.
+ */
+export const REVIEW_FILTERS: {
+    param: string;
+    type: string;
+    label: string;
+}[];
+export const REVIEW_SORT_OPTIONS: string[];
+export const REVIEW_SETTINGS_LIFETIME: number;
+export const REQUEST_PRODUCT_REVIEW_SETTINGS: "REQUEST_PRODUCT_REVIEW_SETTINGS";
+export const RECEIVE_PRODUCT_REVIEW_SETTINGS: "RECEIVE_PRODUCT_REVIEW_SETTINGS";
+export const ERROR_PRODUCT_REVIEW_SETTINGS: "ERROR_PRODUCT_REVIEW_SETTINGS";
+export const PAGINATION_TYPE_OFFSET: "offset";
+export const PAGINATION_TYPE_CURSOR: "cursor";
+/**
+ * Max number of reviews shown
+ * @type {number}
+ */
+export const REVIEW_PREVIEW_COUNT: number;
+/**
+ * Number of reviews loaded per request on the full review page.
+ * @type {number}
+ */
+export const REVIEW_ITEMS_PER_PAGE: number;
+//# sourceMappingURL=index.d.ts.map

package/reviews/constants/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../reviews/constants/index.js"],"names":[],"mappings":"AACA,+BAAgC,MAAM,CAAC;AACvC,8BAA+B,iBAAiB,CAAC;AACjD,8BAA+B,iBAAiB,CAAC;AACjD,4BAA6B,eAAe,CAAC;AAG7C,sCAAuC,yBAAyB,CAAC;AACjE,sCAAuC,yBAAyB,CAAC;AACjE,oCAAqC,uBAAuB,CAAC;AAG7D,mCAAoC,MAAM,CAAC;AAC3C,kCAAmC,qBAAqB,CAAC;AACzD,kCAAmC,qBAAqB,CAAC;AACzD,gCAAiC,mBAAmB,CAAC;AACrD,iCAAkC,oBAAoB,CAAC;AAGvD,oCAAqC,uBAAuB,CAAC;AAC7D,oCAAqC,uBAAuB,CAAC;AAC7D,kCAAmC,qBAAqB,CAAC;AACzD,kCAAmC,qBAAqB,CAAC;AAGzD,kCAAmC,qBAAqB,CAAC;AACzD,mCAAoC,aAAa,CAAC;AAGlD,4CAA6C,eAAe,CAAC;AAG7D;;;;GAIG;AACH;;;;IAgBE;AACF,2CAOE;AAGF,8CAAuD;AACvD,8CAA+C,iCAAiC,CAAC;AACjF,8CAA+C,iCAAiC,CAAC;AACjF,4CAA6C,+BAA+B,CAAC;AAC7E,qCAAsC,QAAQ,CAAC;AAC/C,qCAAsC,QAAQ,CAAC;AAE/C;;;GAGG;AACH,mCAFU,MAAM,CAEsB;AAEtC;;;GAGG;AACH,oCAFU,MAAM,CAEwB"}