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

package/reviews/reducers/reviewsByProductId.d.ts

@@ -0,0 +1,23 @@
+import type { Reducer } from 'redux';
+import { REQUEST_SUBMIT_REVIEW } from '../constants';
+import type { RequestProductReviewsAction } from '../action-creators/requestProductReviews';
+import type { ReceiveProductReviewsAction } from '../action-creators/receiveProductReviews';
+import type { ErrorProductReviewsAction } from '../action-creators/errorProductReviews';
+import type { ReviewsByProductId } from '../types/reviews';
+type RequestSubmitReviewAction = {
+    type: typeof REQUEST_SUBMIT_REVIEW;
+    review: {
+        productId: string;
+    };
+};
+type ReviewsByProductIdAction = RequestProductReviewsAction | ReceiveProductReviewsAction | ErrorProductReviewsAction | RequestSubmitReviewAction;
+/**
+ * Stores product reviews by their product ID.
+ * Responses are only applied when they belong to the latest request of a product.
+ * @param state The current state.
+ * @param action The action object.
+ * @returns The new state.
+ */
+declare const reviewsByProductId: Reducer<ReviewsByProductId, ReviewsByProductIdAction>;
+export default reviewsByProductId;
+//# sourceMappingURL=reviewsByProductId.d.ts.map

package/reviews/reducers/reviewsByProductId.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reviewsByProductId.d.ts","sourceRoot":"","sources":["../../../reviews/reducers/reviewsByProductId.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AACrC,OAAO,EAIL,qBAAqB,EAEtB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,0CAA0C,CAAC;AAC5F,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,0CAA0C,CAAC;AAC5F,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,wCAAwC,CAAC;AACxF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAE3D,KAAK,yBAAyB,GAAG;IAC/B,IAAI,EAAE,OAAO,qBAAqB,CAAC;IACnC,MAAM,EAAE;QACN,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH,CAAC;AAEF,KAAK,wBAAwB,GACzB,2BAA2B,GAC3B,2BAA2B,GAC3B,yBAAyB,GACzB,yBAAyB,CAAC;AAE9B;;;;;;GAMG;AACH,QAAA,MAAM,kBAAkB,EAAE,OAAO,CAAC,kBAAkB,EAAE,wBAAwB,CA+D7E,CAAC;AAEF,eAAe,kBAAkB,CAAC"}

package/reviews/reducers/reviewsByProductId.js

@@ -1,12 +1,12 @@
 import { REQUEST_PRODUCT_REVIEWS, RECEIVE_PRODUCT_REVIEWS, ERROR_PRODUCT_REVIEWS, REQUEST_SUBMIT_REVIEW, REVIEWS_LIFETIME } from "../constants";
-
 /**
  * Stores product reviews by their product ID.
- * @param {Object} [state={}] The current state.
- * @param {Object} action The action object.
- * @return {Object} The new state.
+ * Responses are only applied when they belong to the latest request of a product.
+ * @param state The current state.
+ * @param action The action object.
+ * @returns The new state.
  */
-export default function reviewsByProductId(state = {}, action = {}) {
+const reviewsByProductId = (state = {}, action = {}) => {
   switch (action.type) {
     case REQUEST_PRODUCT_REVIEWS:
       return {
@@ -14,29 +14,43 @@ export default function reviewsByProductId(state = {}, action = {}) {
         [action.productId]: {
           ...state[action.productId],
           isFetching: true,
-          expires: 0
+          expires: 0,
+          requestId: action.requestId
         }
       };
     case RECEIVE_PRODUCT_REVIEWS:
-      return {
-        ...state,
-        [action.productId]: {
-          ...state[action.productId],
-          isFetching: false,
-          reviews: action.reviews.map(review => review.id),
-          totalReviewCount: action.totalReviewCount,
-          expires: Date.now() + REVIEWS_LIFETIME
+      {
+        const collection = state[action.productId];
+        if (!collection || collection.requestId !== action.requestId) {
+          return state;
         }
-      };
+        return {
+          ...state,
+          [action.productId]: {
+            ...collection,
+            isFetching: false,
+            reviews: action.reviews.map(review => review.id),
+            sort: action.sort,
+            totalReviewCount: typeof action.totalReviewCount === 'number' ? action.totalReviewCount : null,
+            expires: Date.now() + REVIEWS_LIFETIME
+          }
+        };
+      }
     case ERROR_PRODUCT_REVIEWS:
-      return {
-        ...state,
-        [action.productId]: {
-          ...state[action.productId],
-          isFetching: false,
-          expires: 0
+      {
+        const collection = state[action.productId];
+        if (!collection || collection.requestId !== action.requestId) {
+          return state;
         }
-      };
+        return {
+          ...state,
+          [action.productId]: {
+            ...collection,
+            isFetching: false,
+            expires: 0
+          }
+        };
+      }
     case REQUEST_SUBMIT_REVIEW:
       return {
         ...state,
@@ -48,4 +62,5 @@ export default function reviewsByProductId(state = {}, action = {}) {
     default:
       return state;
   }
-}
+};
+export default reviewsByProductId;

package/reviews/selectors/index.d.ts

@@ -0,0 +1,278 @@
+import type { Review, ReviewListFilters, ReviewsProductProps, ReviewsProductState, ReviewsState } from '../types/reviews';
+export * from './reviewSettings';
+export * from './reviewSummary';
+export * from './ownReviewVotes';
+type AuthorState = {
+    user: {
+        login?: {
+            isLoggedIn?: boolean;
+        } | null;
+        data?: {
+            firstName?: string;
+            lastName?: string;
+        } | null;
+    };
+};
+/**
+ * Retrieves the reviews collection which contains all reviews data.
+ * @param state The current application state.
+ * @returns The reviews collection stored as reviewId => review pairs.
+ */
+export declare const getReviews: ((state: ReviewsState) => import("../types/reviews").ReviewsById) & import("reselect").OutputSelectorFields<(args_0: import("../types/reviews").ReviewsSliceState) => import("../types/reviews").ReviewsById, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * Retrieves the number of reviews for a product
+ * @param state The current application state.
+ * @returns The total review count for a product
+ */
+export declare const getProductReviewCount: ((state: ReviewsState & {
+    product: unknown;
+}, props?: ReviewsProductProps | undefined) => number | null) & import("reselect").OutputSelectorFields<(args_0: string | null, args_1: import("../types/reviews").ReviewsByProductId) => number | null, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * Retrieves the total number of reviews for a current product.
+ * @param state The current application state.
+ * @returns The total number of reviews.
+ */
+export declare const getReviewsTotalCount: ((state: ReviewsState & {
+    product: unknown;
+}, props?: ReviewsProductProps | undefined) => number | null) & import("reselect").OutputSelectorFields<(args_0: import("../types/reviews").ReviewsCollection | null) => number | null, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * Retrieves the total number of currently fetched reviews for a current product.
+ * @param state The current application state.
+ * @returns The current number of fetched reviews.
+ */
+export declare const getCurrentReviewCount: ((state: ReviewsState & {
+    product: unknown;
+}, props?: ReviewsProductProps | undefined) => number | null) & import("reselect").OutputSelectorFields<(args_0: import("../types/reviews").ReviewsCollection | null) => number | null, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * 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 declare const getReviewListSort: ((state: ReviewsState & {
+    product: unknown;
+}, props?: ReviewsProductProps | undefined) => string) & import("reselect").OutputSelectorFields<(args_0: import("../types/reviews").ReviewsCollection | null) => string, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * 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 declare const getReviewListFilters: ((state: ReviewsState & {
+    product: unknown;
+}, props?: ReviewsProductProps | undefined) => ReviewListFilters) & import("reselect").OutputSelectorFields<(args_0: import("../types/reviews").ReviewsCollection | null) => ReviewListFilters, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * 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 declare const isReviewListQueryChanged: ((state: ReviewsState & {
+    product: unknown;
+}, props?: ReviewsProductProps | undefined) => boolean) & import("reselect").OutputSelectorFields<(args_0: import("../types/reviews").ReviewsCollection | null) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * 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 declare const hasMoreReviews: ((state: ReviewsState & {
+    product: unknown;
+} & import("../types/reviewSettings").ReviewSettingsState, props?: ReviewsProductProps | undefined) => boolean) & import("reselect").OutputSelectorFields<(args_0: import("../types/reviews").ReviewsCollection | null, args_1: number | null, args_2: number | null, args_3: boolean) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * Retrieves the information if reviews are currently fetched.
+ * @param state The current application state.
+ * @returns The boolean information if reviews are currently being fetched.
+ */
+export declare const getReviewsFetchingState: ((state: ReviewsState & {
+    product: unknown;
+}, props?: ReviewsProductProps | undefined) => boolean | null | undefined) & import("reselect").OutputSelectorFields<(args_0: import("../types/reviews").ReviewsCollection | null) => boolean | null | undefined, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * 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 declare const isReviewListMissing: ((state: ReviewsState & {
+    product: unknown;
+}, props?: ReviewsProductProps | undefined) => boolean) & import("reselect").OutputSelectorFields<(args_0: import("../types/reviews").ReviewsCollection | null) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * 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 declare const hasReviewListError: ((state: ReviewsState & {
+    product: unknown;
+}, props?: ReviewsProductProps | undefined) => boolean) & import("reselect").OutputSelectorFields<(args_0: import("../types/reviews").ReviewsCollection | null) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * 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 declare const isReviewListStale: (state: ReviewsProductState, props?: ReviewsProductProps) => boolean;
+/**
+ * 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 declare const isReviewListLoading: ((state: ReviewsState & {
+    product: unknown;
+}, props?: ReviewsProductProps | undefined) => boolean) & import("reselect").OutputSelectorFields<(args_0: import("../types/reviews").ReviewsCollection | null, args_1: boolean) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * 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 declare const getReviewListRequestOffset: ((state: ReviewsState & {
+    product: unknown;
+}, props?: ReviewsProductProps | undefined) => number) & import("reselect").OutputSelectorFields<(args_0: import("../types/reviews").ReviewsCollection | null) => number, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * Retrieves a user review for a product.
+ */
+export declare const getUserReviewForProduct: ((state: ReviewsState, props?: ReviewsProductProps | undefined) => Partial<Review>) & import("reselect").OutputSelectorFields<(args_0: import("../types/reviews").UserReviewsByProductId, args_1: import("../types/reviews").ReviewsById, args_2: string | null | undefined) => Partial<Review>, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * Gets user reviews fetching state. Only the first fetch is considered.
+ * @returns True if user review for current product is being fetched.
+ */
+export declare const getUserReviewFirstFetchState: ((state: ReviewsState & {
+    product: unknown;
+}, props?: ReviewsProductProps | undefined) => boolean) & import("reselect").OutputSelectorFields<(args_0: string | null, args_1: import("../types/reviews").UserReviewsByProductId) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * Get a user name for the review form.
+ * @param state The state.
+ * @returns A user name.
+ */
+export declare const getDefaultAuthorName: (state: AuthorState) => string;
+/**
+ * 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 declare const getProductReviews: ((state: ReviewsState & {
+    product: unknown;
+}, props?: ReviewsProductProps | undefined) => Review[]) & import("reselect").OutputSelectorFields<(args_0: import("../types/reviews").ReviewsCollection | null, args_1: import("../types/reviews").ReviewsById) => Review[], {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * 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 declare const getProductReviewsExcerpt: ((state: ReviewsState & {
+    product: unknown;
+}, props?: ReviewsProductProps | undefined) => Review[] | null) & import("reselect").OutputSelectorFields<(args_0: string | null, args_1: import("../types/reviews").ReviewsByProductId, args_2: import("../types/reviews").ReviewsById) => Review[] | null, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * 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 declare const isProductReviewsExcerptMissing: ((state: ReviewsState & {
+    product: unknown;
+}, props?: ReviewsProductProps | undefined) => boolean) & import("reselect").OutputSelectorFields<(args_0: import("../types/reviews").ProductReviewsCollection) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * 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 declare const hasProductReviewsExcerptError: ((state: ReviewsState & {
+    product: unknown;
+}, props?: ReviewsProductProps | undefined) => boolean) & import("reselect").OutputSelectorFields<(args_0: import("../types/reviews").ProductReviewsCollection) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * 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 declare const isProductReviewsExcerptLoading: ((state: ReviewsState & {
+    product: unknown;
+}, props?: ReviewsProductProps | undefined) => boolean) & import("reselect").OutputSelectorFields<(args_0: import("../types/reviews").ProductReviewsCollection, args_1: boolean) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * 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 declare const isProductReviewsExcerptPending: ((state: ReviewsState & {
+    product: unknown;
+}, props?: ReviewsProductProps | undefined) => boolean) & import("reselect").OutputSelectorFields<(args_0: import("../types/reviews").ProductReviewsCollection) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../reviews/selectors/index.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EACV,MAAM,EAEN,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,YAAY,EACb,MAAM,kBAAkB,CAAC;AAK1B,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AAEjC,KAAK,WAAW,GAAG;IACjB,IAAI,EAAE;QACJ,KAAK,CAAC,EAAE;YACN,UAAU,CAAC,EAAE,OAAO,CAAC;SACtB,GAAG,IAAI,CAAC;QACT,IAAI,CAAC,EAAE;YACL,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB,GAAG,IAAI,CAAC;KACV,CAAC;CACH,CAAC;AAiEF;;;;GAIG;AACH,eAAO,MAAM,UAAU;;;;CAGtB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,qBAAqB;;;;;;CAYjC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,oBAAoB;;;;;;CAShC,CAAC;AACF;;;;GAIG;AACH,eAAO,MAAM,qBAAqB;;;;;;CASjC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB;;;;;;CAG7B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,oBAAoB;;;;;;CAGhC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB;;;;;;CAQpC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc;;;;;;CAgB1B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,uBAAuB;;;;;;CAGnC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;;;;;;CAG/B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,kBAAkB;;;;;;CAG9B,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAC5B,OAAO,mBAAmB,EAC1B,QAAQ,mBAAmB,YAK5B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;;;;;;CAI/B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,0BAA0B;;;;;;CAGtC,CAAC;AAYF;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;CAenC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,4BAA4B;;;;;;CAWxC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,GAAI,OAAO,WAAW,WAGtD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB;;;;;;CAU7B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,wBAAwB;;;;;;CAapC,CAAC;AAaF;;;;GAIG;AACH,eAAO,MAAM,8BAA8B;;;;;;CAG1C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,6BAA6B;;;;;;CAMzC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,8BAA8B;;;;;;CAI1C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,8BAA8B;;;;;;CAG1C,CAAC"}