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

package/reviews/types/reviewSummary.js

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

package/reviews/types/reviews.d.ts

@@ -0,0 +1,190 @@
+import type { ReviewSettingsSliceState } from './reviewSettings';
+import type { ReviewSummary } from './reviewSummary';
+export type ReviewId = string | number;
+/**
+ * A reply of the merchant to a product review.
+ */
+export interface ReviewMerchantReply {
+    author?: string;
+    date?: string;
+    /** Plain text; never rendered as HTML. */
+    reply?: string;
+}
+/**
+ * A provider-defined label/value pair attached to a product review.
+ */
+export interface ReviewCustomField {
+    label: string;
+    value: string;
+}
+/**
+ * An image or video attached to a product review.
+ */
+export interface ReviewMediaItem {
+    type: 'image' | 'video';
+    url: string;
+}
+/**
+ * The helpfulness votes of a product review.
+ */
+export interface ReviewVoteCounts {
+    up?: number;
+    down?: number;
+}
+export type ReviewVote = 'up' | 'down';
+/**
+ * A product review as stored in the reviews slice.
+ */
+export interface Review {
+    id: ReviewId;
+    author?: string;
+    date?: string;
+    rate: number;
+    title?: string;
+    review?: string;
+    /** Only set on reviews that were submitted from the write form. */
+    productId?: string;
+    /** A missing value is unknown, which differs from an explicit `false`. */
+    isVerified?: boolean;
+    merchantReply?: ReviewMerchantReply;
+    customFields?: ReviewCustomField[];
+    media?: ReviewMediaItem[];
+    /** Missing counts are unknown, which differs from an explicit zero. */
+    reviewVotes?: ReviewVoteCounts;
+}
+/**
+ * The active filters of a review list by request parameter; inactive filters are left out.
+ */
+export interface ReviewListFilters {
+    filterMedia?: true;
+    filterVerified?: true;
+    /** Number of stars from 1 to 5. */
+    filterRate?: number;
+}
+/**
+ * Filter values as callers pass them; they are reduced to `ReviewListFilters` before use.
+ */
+export type ReviewListFilterInput = Partial<Record<keyof ReviewListFilters, boolean | number | null>>;
+/**
+ * A list filter the provider supports: its request parameter and the label of its control.
+ */
+export interface ReviewFilterOption {
+    param: keyof ReviewListFilters;
+    type: 'toggle' | 'rate';
+    label: string;
+}
+/**
+ * Request bookkeeping that ties a review list response to the request that caused it.
+ */
+export interface ReviewsRequestMeta {
+    requestId?: number;
+    offset?: number;
+    /** Opaque sort value; extensions may pass their own format. */
+    sort?: string;
+    /** The active list filters; missing when the list is unfiltered. */
+    filters?: ReviewListFilters;
+}
+/**
+ * A full review list stored under its request hash.
+ */
+export interface ReviewsCollection {
+    reviews?: ReviewId[];
+    totalReviewCount?: number | null;
+    sort?: string;
+    isFetching?: boolean;
+    expires?: number;
+    requestId?: number;
+    requestOffset?: number;
+    requestSort?: string;
+    requestFilters?: ReviewListFilters;
+    /** The filters the stored reviews were loaded with. */
+    filters?: ReviewListFilters;
+    /** Cursor for the next page; null when the provider returned none. */
+    after?: string | null;
+}
+/**
+ * The review preview of a product stored under its product id.
+ */
+export interface ProductReviewsCollection {
+    reviews?: ReviewId[];
+    totalReviewCount?: number | null;
+    sort?: string;
+    isFetching?: boolean;
+    expires?: number;
+    requestId?: number;
+}
+/**
+ * The own review reference of the logged-in user for a product.
+ */
+export interface UserReviewReference {
+    review?: ReviewId;
+    isFetching?: boolean;
+    expires?: number;
+}
+export type ReviewsById = Record<string, Review>;
+export type ReviewsByHash = Record<string, ReviewsCollection>;
+export type ReviewsByProductId = Record<string, ProductReviewsCollection>;
+export type UserReviewsByProductId = Record<string, UserReviewReference>;
+/**
+ * The review list parts of the reviews redux slice.
+ */
+export interface ReviewsSliceState {
+    reviewsById: ReviewsById;
+    reviewsByHash: ReviewsByHash;
+    reviewsByProductId: ReviewsByProductId;
+    userReviewsByProductId: UserReviewsByProductId;
+    reviewSettings?: ReviewSettingsSliceState;
+    /** Provider summaries by the product id the reviews were requested for. */
+    reviewSummariesByProductId?: Record<string, ReviewSummary>;
+}
+/**
+ * Minimal application state shape the review list selectors read from.
+ */
+export interface ReviewsState {
+    reviews: ReviewsSliceState;
+}
+/**
+ * Application state shape for review selectors that also resolve the base product.
+ */
+export type ReviewsProductState = ReviewsState & {
+    product: unknown;
+};
+/**
+ * Selector props that identify a product and optionally one of its variants.
+ */
+export interface ReviewsProductProps {
+    productId?: string | null;
+    variantId?: string | null;
+}
+/**
+ * The review switches of the app config.
+ */
+export interface ReviewsConfig {
+    hasReviews?: boolean;
+    showWriteReview?: boolean;
+}
+/**
+ * The votes the user of this device gave, stored by review id outside the reviews slice so
+ * that an app reset keeps them.
+ */
+export type OwnReviewVotes = Record<string, ReviewVote>;
+/**
+ * Minimal application state shape the review vote selectors read from.
+ */
+export interface OwnReviewVotesState {
+    ownReviewVotes?: OwnReviewVotes;
+}
+/**
+ * The pipeline response of shopgate.catalog.getProductReviews.v1.
+ */
+export interface ProductReviewsResponse {
+    reviews: Review[];
+    totalReviewCount?: number | null;
+    /** Unfiltered rating summary of the product; providers send it with a first page. */
+    ratingSummary?: unknown;
+    /** Only sent by providers with cursor pagination; no `after` means the last page. */
+    cursors?: {
+        after?: string | null;
+    };
+}
+//# sourceMappingURL=reviews.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"reviews.d.ts","sourceRoot":"","sources":["../../../reviews/types/reviews.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AACjE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,0CAA0C;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;IACxB,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,UAAU,GAAG,IAAI,GAAG,MAAM,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,QAAQ,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mEAAmE;IACnE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,aAAa,CAAC,EAAE,mBAAmB,CAAC;IACpC,YAAY,CAAC,EAAE,iBAAiB,EAAE,CAAC;IACnC,KAAK,CAAC,EAAE,eAAe,EAAE,CAAC;IAC1B,uEAAuE;IACvE,WAAW,CAAC,EAAE,gBAAgB,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,cAAc,CAAC,EAAE,IAAI,CAAC;IACtB,mCAAmC;IACnC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,CACzC,MAAM,CAAC,MAAM,iBAAiB,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC,CACzD,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,iBAAiB,CAAC;IAC/B,IAAI,EAAE,QAAQ,GAAG,MAAM,CAAC;IACxB,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+DAA+D;IAC/D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oEAAoE;IACpE,OAAO,CAAC,EAAE,iBAAiB,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,iBAAiB,CAAC;IACnC,uDAAuD;IACvD,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAC5B,sEAAsE;IACtE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACjD,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC9D,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,WAAW,CAAC;IACzB,aAAa,EAAE,aAAa,CAAC;IAC7B,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,cAAc,CAAC,EAAE,wBAAwB,CAAC;IAC1C,2EAA2E;IAC3E,0BAA0B,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;CAC5D;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,iBAAiB,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG;IAAE,OAAO,EAAE,OAAO,CAAA;CAAE,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,qFAAqF;IACrF,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,qFAAqF;IACrF,OAAO,CAAC,EAAE;QACR,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB,CAAC;CACH"}

package/reviews/types/reviews.js

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