@putiikkipalvelu/storefront-sdk 0.11.1 → 0.12.0

package/dist/index.js

@@ -1849,6 +1849,78 @@ function createWithdrawalResource(fetcher) {
   };
 }
 
+// src/resources/reviews.ts
+function createReviewsResource(fetcher) {
+  return {
+    /**
+     * List approved reviews for a product, with the aggregate rating and a
+     * 1–5 star distribution.
+     *
+     * @param slug - Product URL slug
+     * @param options - Fetch options (caching, headers, etc.)
+     * @returns Approved reviews, average rating, count, and distribution
+     *
+     * @example
+     * ```typescript
+     * const { reviews, averageRating, reviewCount } =
+     *   await client.reviews.list('my-product');
+     * ```
+     */
+    async list(slug, options) {
+      return fetcher.request(
+        `/api/storefront/v1/reviews/${encodeURIComponent(slug)}`,
+        {
+          ...options
+        }
+      );
+    },
+    /**
+     * Submit a product review. Anonymous by default; pass a sessionId to submit
+     * as a logged-in customer (enables the verified-purchase check + reward code).
+     * The review is created as PENDING and appears once the store owner approves it.
+     *
+     * @param params - Review data (slug, rating 1–5, body, optional title/authorName)
+     * @param sessionId - Optional customer session id (logged-in submit)
+     * @param options - Fetch options
+     * @returns The created review (PENDING) and a reward code if revealed
+     *
+     * @example Anonymous
+     * ```typescript
+     * await client.reviews.submit({
+     *   slug: 'my-product',
+     *   rating: 5,
+     *   body: 'Loistava tuote!',
+     *   authorName: 'Matti',
+     * });
+     * ```
+     *
+     * @example Logged-in (may return a reward code)
+     * ```typescript
+     * const { reward } = await client.reviews.submit(
+     *   { slug: 'my-product', rating: 5, body: 'Loistava tuote!' },
+     *   sessionId
+     * );
+     * if (reward) console.log(`Käytä koodia ${reward.code}`);
+     * ```
+     */
+    async submit(params, sessionId, options) {
+      const { headers: optionHeaders, ...restOptions } = options ?? {};
+      return fetcher.request(
+        "/api/storefront/v1/reviews",
+        {
+          method: "POST",
+          body: params,
+          headers: {
+            ...sessionId ? { "x-session-id": sessionId } : {},
+            ...optionHeaders ?? {}
+          },
+          ...restOptions
+        }
+      );
+    }
+  };
+}
+
 // src/client.ts
 function createStorefrontClient(config) {
   if (!config.apiKey) {
@@ -1876,7 +1948,8 @@ function createStorefrontClient(config) {
     discountCode: createDiscountCodeResource(fetcher),
     pages: createPagesResource(fetcher),
     tickets: createTicketsResource(fetcher),
-    withdrawal: createWithdrawalResource(fetcher)
+    withdrawal: createWithdrawalResource(fetcher),
+    reviews: createReviewsResource(fetcher)
   };
 }