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

package/reviews/selectors/index.js

@@ -1,33 +1,42 @@
 import { createSelector } from 'reselect';
+import { SORT_DATE_DESC } from '@shopgate/pwa-common/constants/DisplayOptions';
 import { generateResultHash } from '@shopgate/pwa-common/helpers/redux';
 import { isUserLoggedIn } from '@shopgate/pwa-common/selectors/user';
-import { REVIEW_PREVIEW_COUNT } from "../constants";
+import { getBaseProductId as getBaseProductIdSelector } from '@shopgate/engage/product/selectors/product';
 import * as pipelines from "../constants/Pipelines";
-import { getBaseProductId } from "../../product/selectors/product";
+import { areReviewFiltersEqual } from "../helpers/filters";
+import { isReviewCursorPagination } from "./reviewSettings";
+export * from "./reviewSettings";
+export * from "./reviewSummary";
+export * from "./ownReviewVotes";
+const NO_FILTERS = {};
+const getBaseProductId = getBaseProductIdSelector;
 
 /**
- * @param {Object} state The global state.
- * @return {Object}
+ * Selects the reviews slice.
+ * @param state The global state.
+ * @returns The reviews slice.
  */
 const getReviewsState = state => state.reviews;
 
 /**
- * @param {Object} state The global state.
- * @return {Object}
+ * Selects the review previews stored by product id.
+ * @param state The global state.
+ * @returns The review previews stored by product id.
  */
 const getProductReviewsExcerptState = state => state.reviews.reviewsByProductId;
 
 /**
  * Select the product reviews state.
- * @param {Object} state The current application state.
- * @return {Object} The product reviews state.
+ * @param state The current application state.
+ * @returns The product reviews state.
  */
 const getReviewsByHash = createSelector(getReviewsState, state => state.reviewsByHash);
 
 /**
  * Retrieves the fetching state for the current product's reviews.
- * @param {Object} state The current application state.
- * @return {Object|null} The reviews for a product.
+ * @param state The current application state.
+ * @returns The reviews for a product.
  */
 const getCollectionForCurrentBaseProduct = createSelector(getBaseProductId, getReviewsByHash, (productId, reviews) => {
   const hash = generateResultHash({
@@ -42,26 +51,26 @@ const getCollectionForCurrentBaseProduct = createSelector(getBaseProductId, getR
 
 /**
  * Select the product reviews state
- * @param {Object} state The current application state.
- * @return {Object} The product reviews state.
+ * @param state The current application state.
+ * @returns The product reviews state.
  */
 const getReviewsByProductId = createSelector(getReviewsState, state => state.reviewsByProductId);
 
 /**
  * Retrieves the reviews collection which contains all reviews data.
- * @param {Object} state The current application state.
- * @return {Object} The reviews collection stored as reviewId => review pairs.
+ * @param state The current application state.
+ * @returns The reviews collection stored as reviewId => review pairs.
  */
 export const getReviews = createSelector(getReviewsState, state => state.reviewsById || {});
 
 /**
  * Retrieves the number of reviews for a product
- * @param {Object} state The current application state.
- * @return {number} The total review count for a product
+ * @param state The current application state.
+ * @returns The total review count for a product
  */
 export const getProductReviewCount = createSelector(getBaseProductId, getReviewsByProductId, (productId, reviewsState) => {
   const collection = reviewsState[productId];
-  if (!collection || !collection.totalReviewCount) {
+  if (!collection || typeof collection.totalReviewCount !== 'number') {
     return null;
   }
   return collection.totalReviewCount;
@@ -69,19 +78,19 @@ export const getProductReviewCount = createSelector(getBaseProductId, getReviews
 
 /**
  * Retrieves the total number of reviews for a current product.
- * @param {Object} state The current application state.
- * @return {number|null} The total number of reviews.
+ * @param state The current application state.
+ * @returns The total number of reviews.
  */
 export const getReviewsTotalCount = createSelector(getCollectionForCurrentBaseProduct, collection => {
-  if (!collection || !collection.totalReviewCount) {
+  if (!collection || typeof collection.totalReviewCount !== 'number') {
     return null;
   }
   return collection.totalReviewCount;
 });
 /**
  * Retrieves the total number of currently fetched reviews for a current product.
- * @param {Object} state The current application state.
- * @return {number|null} The current number of fetched reviews.
+ * @param state The current application state.
+ * @returns The current number of fetched reviews.
  */
 export const getCurrentReviewCount = createSelector(getCollectionForCurrentBaseProduct, collection => {
   if (!collection || !collection.reviews) {
@@ -90,17 +99,95 @@ export const getCurrentReviewCount = createSelector(getCollectionForCurrentBaseP
   return collection.reviews.length;
 });
 
+/**
+ * Retrieves the sort of the last review list request of the current base product.
+ * @param state The current application state.
+ * @returns The sort, or the default sort when the list was not requested yet.
+ */
+export const getReviewListSort = createSelector(getCollectionForCurrentBaseProduct, collection => collection?.requestSort ?? SORT_DATE_DESC);
+
+/**
+ * Retrieves the filters of the last review list request of the current base product.
+ * @param state The current application state.
+ * @returns The active filters; empty when the list is unfiltered or was not requested yet.
+ */
+export const getReviewListFilters = createSelector(getCollectionForCurrentBaseProduct, collection => collection?.requestFilters ?? NO_FILTERS);
+
+/**
+ * Whether the last request asked for the first page of another sort or filter than the stored
+ * reviews were loaded with. The stored reviews then do not belong to the requested list.
+ * @param state The current application state.
+ * @returns True from the request until its reviews were received, also after it failed.
+ */
+export const isReviewListQueryChanged = createSelector(getCollectionForCurrentBaseProduct, collection => !!collection && collection.requestOffset === 0 && (collection.requestSort !== collection.sort || !areReviewFiltersEqual(collection.requestFilters, collection.filters)));
+
+/**
+ * Whether the review list of the current base product has a further page.
+ * @param state The current application state.
+ * @returns True when the provider returned a cursor for the next page or, with offset
+ * pagination, fewer reviews are loaded than the list contains.
+ */
+export const hasMoreReviews = createSelector(getCollectionForCurrentBaseProduct, getCurrentReviewCount, getReviewsTotalCount, isReviewCursorPagination, (collection, count, totalCount, isCursor) => {
+  if (!count) {
+    return false;
+  }
+  if (isCursor) {
+    return !!collection?.after;
+  }
+  return typeof totalCount === 'number' && count < totalCount;
+});
+
 /**
  * Retrieves the information if reviews are currently fetched.
- * @param {Object} state The current application state.
- * @return {bool} The boolean information if reviews are currently being fetched.
+ * @param state The current application state.
+ * @returns The boolean information if reviews are currently being fetched.
  */
 export const getReviewsFetchingState = createSelector(getCollectionForCurrentBaseProduct, collection => collection && collection.isFetching);
 
+/**
+ * Whether the review list of the current base product was not requested yet.
+ * @param state The current application state.
+ * @returns True when no list collection exists.
+ */
+export const isReviewListMissing = createSelector(getCollectionForCurrentBaseProduct, collection => collection === null);
+
+/**
+ * Whether the last review list request of the current base product failed.
+ * @param state The current application state.
+ * @returns True when the last request failed, also when earlier pages are still stored.
+ */
+export const hasReviewListError = createSelector(getCollectionForCurrentBaseProduct, collection => !!collection && !collection.isFetching && collection.expires === 0);
+
+/**
+ * Whether the review list of the current base product has to be requested again.
+ * Not memoized, because the result depends on the current time.
+ * @param state The current application state.
+ * @param props The product id and an optional variant id.
+ * @returns True when the list is missing, failed or expired, false while a request runs.
+ */
+export const isReviewListStale = (state, props) => {
+  const collection = getCollectionForCurrentBaseProduct(state, props);
+  return !collection || !collection.isFetching && (collection.expires ?? 0) <= Date.now();
+};
+
+/**
+ * Whether the review list of the current base product is still loading.
+ * @param state The current application state.
+ * @returns True while a request runs or before the first response, unless the last request failed.
+ */
+export const isReviewListLoading = createSelector(getCollectionForCurrentBaseProduct, hasReviewListError, (collection, hasError) => !!collection?.isFetching || !collection?.reviews && !hasError);
+
+/**
+ * Retrieves the offset of the last review list request of the current base product.
+ * @param state The current application state.
+ * @returns The offset, or 0 when the list was not requested yet.
+ */
+export const getReviewListRequestOffset = createSelector(getCollectionForCurrentBaseProduct, collection => collection?.requestOffset ?? 0);
+
 /**
  * Select the user reviews state.
- * @param {Object} state The current application state.
- * @return {Object} The user reviews collection stored as productId => review.
+ * @param state The current application state.
+ * @returns The user reviews collection stored as productId => review.
  */
 const getUserReviewsByProductId = createSelector(getReviewsState, state => state.userReviewsByProductId);
 
@@ -108,61 +195,85 @@ const getUserReviewsByProductId = createSelector(getReviewsState, state => state
  * Retrieves a user review for a product.
  */
 export const getUserReviewForProduct = createSelector(getUserReviewsByProductId, getReviews, (state, props = {}) => props.productId, (userReviews, allReviews, productId) => {
-  if (!userReviews || !userReviews[productId] || !allReviews[userReviews[productId].review]) {
+  const userReview = userReviews && userReviews[productId];
+  if (!userReview || !allReviews[userReview.review]) {
     return {};
   }
   return {
-    ...allReviews[userReviews[productId].review]
+    ...allReviews[userReview.review]
   };
 });
 
 /**
  * Gets user reviews fetching state. Only the first fetch is considered.
- * @return {bool} True if user review for current product is being fetched.
+ * @returns True if user review for current product is being fetched.
  */
 export const getUserReviewFirstFetchState = createSelector(getBaseProductId, getUserReviewsByProductId, (productId, userReviews) => !!(userReviews && productId && userReviews[productId] && !userReviews[productId].review && userReviews[productId].isFetching));
 
 /**
  * Get a user name for the review form.
- * @param {Object} state The state.
- * @returns {string} A user name.
+ * @param state The state.
+ * @returns A user name.
  */
-export const getDefaultAuthorName = state => isUserLoggedIn && state.user.data && state.user.data.firstName ? `${state.user.data.firstName} ${state.user.data.lastName}` : '';
+export const getDefaultAuthorName = state => isUserLoggedIn(state) && state.user.data && state.user.data.firstName ? `${state.user.data.firstName} ${state.user.data.lastName}` : '';
 
 /**
- * Retrieves the current product reviews.
- * When the user review is available, it will always be the first entry.
- * @param {Object} state The current application state.
- * @return {Array|null} The reviews for a product.
+ * Retrieves the current product reviews in the order returned by the pipeline.
+ * @param state The current application state.
+ * @returns The reviews for a product.
  */
-export const getProductReviews = createSelector(getCollectionForCurrentBaseProduct, getReviews, getUserReviewForProduct, (collection, allReviews, userReview) => {
+export const getProductReviews = createSelector(getCollectionForCurrentBaseProduct, getReviews, (collection, allReviews) => {
   if (!collection || !collection.reviews) {
     return [];
   }
-  const reviews = collection.reviews.map(id => allReviews[id]);
-  // There is no user review. Returning only from reviews collection.
-  if (!userReview.id) {
-    return reviews;
-  }
-
-  // User review always on top. Avoid duplicates.
-  return [userReview].concat(reviews.filter(r => r.id !== userReview.id));
+  return collection.reviews.map(id => allReviews[id]);
 });
 
 /**
- * Retrieves the current product reviews excerpt.
- * When user review is available, it will always be the first entry.
- * @param {Object} state The current application state.
- * @return {Array|null} The reviews for a product
+ * Retrieves the current product reviews excerpt in the order returned by the pipeline.
+ * @param state The current application state.
+ * @returns The reviews for a product
  */
-export const getProductReviewsExcerpt = createSelector(getBaseProductId, getProductReviewsExcerptState, getReviews, getUserReviewForProduct, (productId, productReviewsState, reviewsState, userReview) => {
+export const getProductReviewsExcerpt = createSelector(getBaseProductId, getProductReviewsExcerptState, getReviews, (productId, productReviewsState, reviewsState) => {
   const collection = productReviewsState[productId];
   if (!collection || !collection.reviews) {
     return null;
   }
-  const reviews = collection.reviews.map(id => reviewsState[id]);
-  if (!userReview.id) {
-    return reviews;
-  }
-  return [userReview].concat(reviews.filter(r => r.id !== userReview.id)).slice(0, REVIEW_PREVIEW_COUNT);
-});
+  return collection.reviews.map(id => reviewsState[id]);
+});
+
+/**
+ * Retrieves the review preview collection of the current base product.
+ * @param state The current application state.
+ * @returns The collection, or null when the preview was not requested yet.
+ */
+const getProductReviewsExcerptCollection = createSelector(getBaseProductId, getProductReviewsExcerptState, (productId, productReviewsState) => productReviewsState[productId] || null);
+
+/**
+ * Whether the review preview of the current base product was not requested yet.
+ * @param state The current application state.
+ * @returns True when no preview collection exists.
+ */
+export const isProductReviewsExcerptMissing = createSelector(getProductReviewsExcerptCollection, collection => collection === null);
+
+/**
+ * Whether the last review preview request of the current base product failed before any
+ * reviews were received.
+ * @param state The current application state.
+ * @returns True when the preview request failed.
+ */
+export const hasProductReviewsExcerptError = createSelector(getProductReviewsExcerptCollection, collection => !!collection && !collection.isFetching && !collection.reviews && collection.requestId !== undefined);
+
+/**
+ * Whether the review preview of the current base product is still loading.
+ * @param state The current application state.
+ * @returns True while a request runs or before the first response, unless the last request failed.
+ */
+export const isProductReviewsExcerptLoading = createSelector(getProductReviewsExcerptCollection, hasProductReviewsExcerptError, (collection, hasError) => !!collection?.isFetching || !collection?.reviews && !hasError);
+
+/**
+ * Whether the review preview of the current base product is requested without stored reviews.
+ * @param state The current application state.
+ * @returns True while a request runs and no response was stored yet; false for a refresh.
+ */
+export const isProductReviewsExcerptPending = createSelector(getProductReviewsExcerptCollection, collection => !!collection?.isFetching && !collection.reviews);

package/reviews/selectors/ownReviewVotes.d.ts

@@ -0,0 +1,9 @@
+import type { ReviewId, ReviewVote, OwnReviewVotesState } from '../types/reviews';
+/**
+ * Selects the vote the user of this device gave for a review.
+ * @param state The application state.
+ * @param reviewId The ID of the review.
+ * @returns The vote, or null when the user did not vote on the review.
+ */
+export declare const getOwnReviewVote: (state: OwnReviewVotesState, reviewId: ReviewId) => ReviewVote | null;
+//# sourceMappingURL=ownReviewVotes.d.ts.map

package/reviews/selectors/ownReviewVotes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ownReviewVotes.d.ts","sourceRoot":"","sources":["../../../reviews/selectors/ownReviewVotes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAElF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAC3B,OAAO,mBAAmB,EAC1B,UAAU,QAAQ,KACjB,UAAU,GAAG,IAEf,CAAC"}

package/reviews/selectors/ownReviewVotes.js

@@ -0,0 +1,7 @@
+/**
+ * Selects the vote the user of this device gave for a review.
+ * @param state The application state.
+ * @param reviewId The ID of the review.
+ * @returns The vote, or null when the user did not vote on the review.
+ */
+export const getOwnReviewVote = (state, reviewId) => state?.ownReviewVotes?.[String(reviewId)] ?? null;

package/reviews/selectors/reviewSettings.d.ts

@@ -0,0 +1,63 @@
+import type { ReviewFilterOption } from '../types/reviews';
+import type { ReviewPaginationType, ReviewSettingsSliceState, ReviewSettingsState } from '../types/reviewSettings';
+/**
+ * Retrieves the review settings slice, falling back to an empty slice when absent.
+ * @param state The application state.
+ * @returns The review settings slice.
+ */
+export declare const getReviewSettingsState: (state: ReviewSettingsState) => ReviewSettingsSliceState;
+export declare const getReviewFeatures: ((state: ReviewSettingsState) => string[]) & import("reselect").OutputSelectorFields<(args_0: ReviewSettingsSliceState) => string[], {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * Selects the pagination mode from the settings only. Returns `undefined` while unknown;
+ * never derived from `features` and never defaulted to offset.
+ */
+export declare const getReviewPaginationType: ((state: ReviewSettingsState) => ReviewPaginationType | undefined) & import("reselect").OutputSelectorFields<(args_0: ReviewSettingsSliceState) => ReviewPaginationType | undefined, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+export declare const getReviewCustomFields: ((state: ReviewSettingsState) => unknown[]) & import("reselect").OutputSelectorFields<(args_0: ReviewSettingsSliceState) => unknown[], {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * Selects the sort values the provider supports, limited to the sort values the PWA knows
+ * and kept in the provider's order.
+ */
+export declare const getReviewSortOptions: ((state: ReviewSettingsState) => string[]) & import("reselect").OutputSelectorFields<(args_0: ReviewSettingsSliceState) => string[], {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * Selects the list filters the provider supports, in the order the PWA defines them.
+ */
+export declare const getReviewFilterOptions: ((state: ReviewSettingsState) => ReviewFilterOption[]) & import("reselect").OutputSelectorFields<(args_0: string[]) => ReviewFilterOption[], {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+export declare const isFetchingReviewSettings: ((state: ReviewSettingsState) => boolean) & import("reselect").OutputSelectorFields<(args_0: ReviewSettingsSliceState) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+export declare const isReviewCursorPagination: ((state: ReviewSettingsState) => boolean) & import("reselect").OutputSelectorFields<(args_0: ReviewPaginationType | undefined) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * Whether the active provider reports the given capability. A capability missing from the
+ * settings enables nothing.
+ * @param state The application state.
+ * @param feature The capability identifier to check.
+ * @returns Whether the capability is enabled.
+ */
+export declare const hasReviewFeature: (state: ReviewSettingsState, feature: string) => boolean;
+//# sourceMappingURL=reviewSettings.d.ts.map

package/reviews/selectors/reviewSettings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reviewSettings.d.ts","sourceRoot":"","sources":["../../../reviews/selectors/reviewSettings.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,KAAK,EACV,oBAAoB,EACpB,wBAAwB,EACxB,mBAAmB,EACpB,MAAM,yBAAyB,CAAC;AAIjC;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,GAAI,OAAO,mBAAmB,KAAG,wBAClB,CAAC;AAEnD,eAAO,MAAM,iBAAiB;;;;CAG7B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,uBAAuB;;;;CAGnC,CAAC;AAEF,eAAO,MAAM,qBAAqB;;;;CAGjC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,oBAAoB;;;;CAKhC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;CAIlC,CAAC;AAEF,eAAO,MAAM,wBAAwB;;;;CAGpC,CAAC;AAEF,eAAO,MAAM,wBAAwB;;;;CAGpC,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,GAAI,OAAO,mBAAmB,EAAE,SAAS,MAAM,KAAG,OACnC,CAAC"}

package/reviews/selectors/reviewSettings.js

@@ -0,0 +1,40 @@
+import { createSelector } from 'reselect';
+import { PAGINATION_TYPE_CURSOR, REVIEW_FILTERS, REVIEW_SORT_OPTIONS } from "../constants";
+const EMPTY_SETTINGS = {};
+
+/**
+ * Retrieves the review settings slice, falling back to an empty slice when absent.
+ * @param state The application state.
+ * @returns The review settings slice.
+ */
+export const getReviewSettingsState = state => state?.reviews?.reviewSettings ?? EMPTY_SETTINGS;
+export const getReviewFeatures = createSelector(getReviewSettingsState, settings => settings.features ?? []);
+
+/**
+ * Selects the pagination mode from the settings only. Returns `undefined` while unknown;
+ * never derived from `features` and never defaulted to offset.
+ */
+export const getReviewPaginationType = createSelector(getReviewSettingsState, settings => settings.paginationType);
+export const getReviewCustomFields = createSelector(getReviewSettingsState, settings => settings.customFields ?? []);
+
+/**
+ * Selects the sort values the provider supports, limited to the sort values the PWA knows
+ * and kept in the provider's order.
+ */
+export const getReviewSortOptions = createSelector(getReviewSettingsState, settings => Array.isArray(settings.sortOptions) ? settings.sortOptions.filter(option => REVIEW_SORT_OPTIONS.includes(option)) : []);
+
+/**
+ * Selects the list filters the provider supports, in the order the PWA defines them.
+ */
+export const getReviewFilterOptions = createSelector(getReviewFeatures, features => REVIEW_FILTERS.filter(filter => features.includes(filter.param)));
+export const isFetchingReviewSettings = createSelector(getReviewSettingsState, settings => settings.isFetching ?? false);
+export const isReviewCursorPagination = createSelector(getReviewPaginationType, paginationType => paginationType === PAGINATION_TYPE_CURSOR);
+
+/**
+ * Whether the active provider reports the given capability. A capability missing from the
+ * settings enables nothing.
+ * @param state The application state.
+ * @param feature The capability identifier to check.
+ * @returns Whether the capability is enabled.
+ */
+export const hasReviewFeature = (state, feature) => getReviewFeatures(state).includes(feature);

package/reviews/selectors/reviewSummary.d.ts

@@ -0,0 +1,18 @@
+import type { ReviewsProductProps, ReviewsSliceState } from '../types/reviews';
+import type { ReviewSummary } from '../types/reviewSummary';
+type SummaryState = {
+    product: unknown;
+    reviews?: Partial<ReviewsSliceState>;
+};
+/**
+ * Selects the review summary of a product. A summary delivered by the review provider wins.
+ * Without one the product data is the source, unless the provider reports that it delivers
+ * summaries: then the product data describes another dataset and is not used.
+ * @param state The application state.
+ * @param props The product id and an optional variant id, which takes precedence for the
+ * product data. Provider summaries are stored by the product id.
+ * @returns The summary, or null when none is available.
+ */
+export declare const getReviewSummary: (state: SummaryState, props?: ReviewsProductProps) => ReviewSummary | null;
+export {};
+//# sourceMappingURL=reviewSummary.d.ts.map

package/reviews/selectors/reviewSummary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reviewSummary.d.ts","sourceRoot":"","sources":["../../../reviews/selectors/reviewSummary.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAE5D,KAAK,YAAY,GAAG;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACtC,CAAC;AAsCF;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,GAAI,OAAO,YAAY,EAAE,QAAO,mBAAwB,yBAcpF,CAAC"}

package/reviews/selectors/reviewSummary.js

@@ -0,0 +1,45 @@
+import { createSelector } from 'reselect';
+import { getProductRating as getProductRatingSelector } from "../../product/selectors/product";
+import { REVIEW_FEATURE_RATING_SUMMARY } from "../constants";
+import { hasReviewFeature } from "./reviewSettings";
+const getProductRating = getProductRatingSelector;
+
+/**
+ * Normalizes a raw rating value.
+ * @param value A raw rating value from the product data.
+ * @returns The value when it is a finite number, otherwise null.
+ */
+const toFiniteNumber = value => typeof value === 'number' && Number.isFinite(value) ? value : null;
+
+/**
+ * Selects the review summary of a product from its product data.
+ */
+const getProductReviewSummary = createSelector(getProductRating, rating => {
+  if (!rating) {
+    return null;
+  }
+  return {
+    average: toFiniteNumber(rating.average),
+    count: toFiniteNumber(rating.count)
+  };
+});
+
+/**
+ * Selects the review summary of a product. A summary delivered by the review provider wins.
+ * Without one the product data is the source, unless the provider reports that it delivers
+ * summaries: then the product data describes another dataset and is not used.
+ * @param state The application state.
+ * @param props The product id and an optional variant id, which takes precedence for the
+ * product data. Provider summaries are stored by the product id.
+ * @returns The summary, or null when none is available.
+ */
+export const getReviewSummary = (state, props = {}) => {
+  const providerSummary = props.productId ? state.reviews?.reviewSummariesByProductId?.[props.productId] : undefined;
+  if (providerSummary) {
+    return providerSummary;
+  }
+  if (hasReviewFeature(state, REVIEW_FEATURE_RATING_SUMMARY)) {
+    return null;
+  }
+  return getProductReviewSummary(state, props);
+};

package/reviews/streams/index.js

@@ -1,4 +1,7 @@
 import { main$ } from '@shopgate/pwa-common/streams/main';
+import { RESET_APP } from '@shopgate/pwa-common/constants/ActionTypes';
+import { RESET_APP_REDUCERS } from '@shopgate/pwa-common/constants/Configuration';
+import configuration from '@shopgate/pwa-common/collections/Configuration';
 import { routeWillEnter$, routeWillLeave$ } from '@shopgate/pwa-common/streams/router';
 import { ITEM_PATH, RECEIVE_PRODUCT, RECEIVE_PRODUCT_CACHED } from '@shopgate/pwa-common-commerce/product/constants';
 import { REQUEST_SUBMIT_REVIEW, RECEIVE_SUBMIT_REVIEW, ERROR_SUBMIT_REVIEW, RESET_SUBMIT_REVIEW } from "../constants";
@@ -42,4 +45,19 @@ export const errorReviewSubmit$ = main$.filter(({
 }) => [ERROR_SUBMIT_REVIEW, RESET_SUBMIT_REVIEW].includes(action.type));
 export const shouldFetchReviews$ = main$.filter(({
   action
-}) => action.type === RECEIVE_PRODUCT || action.type === RECEIVE_PRODUCT_CACHED).merge(successReviewSubmit$);
+}) => action.type === RECEIVE_PRODUCT || action.type === RECEIVE_PRODUCT_CACHED).merge(successReviewSubmit$);
+
+/**
+ * Gets triggered after an app reset cleared the reviews state.
+ * A reset without an explicit reducer list uses the configured reset reducers.
+ * @type {Observable}
+ */
+export const reviewsDidReset$ = main$.filter(({
+  action
+}) => {
+  if (action.type !== RESET_APP) {
+    return false;
+  }
+  const resetReducers = action.reducers || configuration.get(RESET_APP_REDUCERS);
+  return Array.isArray(resetReducers) && resetReducers.includes('reviews');
+});

package/reviews/subscriptions/index.js

@@ -1,7 +1,9 @@
 import appConfig from '@shopgate/pwa-common/helpers/config';
+import { appWillStart$ } from '@shopgate/engage/core/streams';
 import fetchProductReviews from "../actions/fetchProductReviews";
+import fetchProductReviewSettings from "../actions/fetchProductReviewSettings";
 import { REVIEW_PREVIEW_COUNT } from "../constants";
-import { shouldFetchReviews$ } from "../streams";
+import { reviewsDidReset$, shouldFetchReviews$ } from "../streams";
 
 /**
  * Review subscriptions.
@@ -11,10 +13,21 @@ export default function product(subscribe) {
   if (!appConfig.hasReviews) {
     return;
   }
+  subscribe(appWillStart$, ({
+    dispatch
+  }) => {
+    dispatch(fetchProductReviewSettings());
+  });
+  subscribe(reviewsDidReset$, ({
+    dispatch
+  }) => {
+    dispatch(fetchProductReviewSettings());
+  });
   subscribe(shouldFetchReviews$, ({
     action,
     dispatch
   }) => {
+    dispatch(fetchProductReviewSettings());
     if (action.productData) {
       const {
         id,

package/reviews/types/reviewSettings.d.ts

@@ -0,0 +1,31 @@
+export type ReviewPaginationType = 'offset' | 'cursor';
+/**
+ * Provider review capabilities returned by shopgate.catalog.getProductReviewSettings.v1.
+ */
+export interface ReviewSettings {
+    /** Optional capabilities the provider supports; the PWA only acts on identifiers it knows. */
+    features: string[];
+    /** Whether the review list paginates by offset or cursor. */
+    paginationType: ReviewPaginationType;
+    /** Provider custom-field definitions; not consumed for display in the first delivery. */
+    customFields: unknown[];
+    /** Sort values the provider supports for the review list; unknown values are ignored. */
+    sortOptions?: string[];
+}
+/**
+ * The review settings redux slice: the loaded settings plus request bookkeeping.
+ * Empty before the first successful load, so every settings field is optional here.
+ */
+export interface ReviewSettingsSliceState extends Partial<ReviewSettings> {
+    isFetching?: boolean;
+    expires?: number;
+}
+/**
+ * Minimal application state shape the review settings selectors read from.
+ */
+export interface ReviewSettingsState {
+    reviews?: {
+        reviewSettings?: ReviewSettingsSliceState;
+    };
+}
+//# sourceMappingURL=reviewSettings.d.ts.map

package/reviews/types/reviewSettings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reviewSettings.d.ts","sourceRoot":"","sources":["../../../reviews/types/reviewSettings.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,oBAAoB,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,8FAA8F;IAC9F,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,6DAA6D;IAC7D,cAAc,EAAE,oBAAoB,CAAC;IACrC,yFAAyF;IACzF,YAAY,EAAE,OAAO,EAAE,CAAC;IACxB,yFAAyF;IACzF,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,OAAO,CAAC,cAAc,CAAC;IACvE,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE;QACR,cAAc,CAAC,EAAE,wBAAwB,CAAC;KAC3C,CAAC;CACH"}

package/reviews/types/reviewSettings.js

@@ -0,0 +1 @@
+export {};

package/reviews/types/reviewSummary.d.ts

@@ -0,0 +1,16 @@
+/**
+ * The number of ratings per number of stars, from 5 to 1.
+ */
+export type ReviewRatingDistribution = Record<'5' | '4' | '3' | '2' | '1', number>;
+/**
+ * The review summary of a product, from the review provider or from the product data.
+ */
+export interface ReviewSummary {
+    /** Average rating on the 0–100 scale; null when not provided. */
+    average: number | null;
+    /** Number of ratings incl. star-only ratings; differs from the list's totalReviewCount. */
+    count: number | null;
+    /** Only set when the review provider delivers a complete distribution. */
+    distribution?: ReviewRatingDistribution;
+}
+//# sourceMappingURL=reviewSummary.d.ts.map

package/reviews/types/reviewSummary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reviewSummary.d.ts","sourceRoot":"","sources":["../../../reviews/types/reviewSummary.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,EAAE,MAAM,CAAC,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,iEAAiE;IACjE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,2FAA2F;IAC3F,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,0EAA0E;IAC1E,YAAY,CAAC,EAAE,wBAAwB,CAAC;CACzC"}