create-brainerce-store 1.68.0 → 1.72.0

package/templates/nextjs/ui-canvas/product/review-form.tsx

@@ -5,18 +5,28 @@ import { Link } from '@/core/lib/navigation';
 import { getClient } from '@/core/lib/brainerce';
 import { checkAuthStatus } from '@/core/lib/auth';
 import { useTranslations } from '@/core/lib/translations';
-import type { MyProductReview, ProductReview } from 'brainerce';
+import type { MyProductReview, ProductReview, ReviewPhotoUpload } from 'brainerce';
 
 interface ReviewFormProps {
   productId: string;
 }
 
+type PhotoPolicy = MyProductReview['photos'];
+
 type Stage =
   | { kind: 'loading' }
   | { kind: 'signed_out' }
   | { kind: 'not_eligible'; reason: MyProductReview['reason'] }
-  | { kind: 'submit' }
-  | { kind: 'edit'; review: ProductReview };
+  | { kind: 'submit'; photos: PhotoPolicy }
+  // `existingPhotos` comes from myImages, which INCLUDES photos still awaiting
+  // the merchant — so a customer editing their review sees the one they already
+  // uploaded instead of a form that looks like it lost it.
+  | {
+      kind: 'edit';
+      review: ProductReview;
+      photos: PhotoPolicy;
+      existingPhotos: ReviewPhotoUpload[];
+    };
 
 /**
  * Single component that decides which UI to render for a customer on a PDP:
@@ -51,11 +61,17 @@ export function ReviewForm({ productId }: ReviewFormProps) {
           setStage({ kind: 'not_eligible', reason: me.reason });
           return;
         }
+        const existingPhotos: ReviewPhotoUpload[] = me.myImages.map((img) => ({
+          key: img.assetKey,
+          url: img.thumbnailUrl ?? img.url,
+          width: img.width,
+          height: img.height,
+        }));
         if (me.myReview) {
-          setStage({ kind: 'edit', review: me.myReview });
+          setStage({ kind: 'edit', review: me.myReview, photos: me.photos, existingPhotos });
           return;
         }
-        setStage({ kind: 'submit' });
+        setStage({ kind: 'submit', photos: me.photos });
       } catch {
         if (!cancelled) setStage({ kind: 'not_eligible', reason: 'product_not_found' });
       }
@@ -87,12 +103,14 @@ export function ReviewForm({ productId }: ReviewFormProps) {
       <EditReviewBlock
         productId={productId}
         initial={stage.review}
-        onDeleted={() => setStage({ kind: 'submit' })}
+        photos={stage.photos}
+        existingPhotos={stage.existingPhotos}
+        onDeleted={() => setStage({ kind: 'submit', photos: stage.photos })}
       />
     );
   }
 
-  return <SubmitReviewBlock productId={productId} />;
+  return <SubmitReviewBlock productId={productId} photos={stage.photos} />;
 }
 
 function NotEligibleMessage({ reason }: { reason: MyProductReview['reason'] }) {
@@ -111,17 +129,30 @@ function NotEligibleMessage({ reason }: { reason: MyProductReview['reason'] }) {
   return <p>{message}</p>;
 }
 
-function SubmitReviewBlock({ productId }: { productId: string }) {
-  return <ReviewEditor productId={productId} mode="create" initialRating={5} initialBody="" />;
+function SubmitReviewBlock({ productId, photos }: { productId: string; photos: PhotoPolicy }) {
+  return (
+    <ReviewEditor
+      productId={productId}
+      mode="create"
+      initialRating={5}
+      initialBody=""
+      photos={photos}
+      initialPhotos={[]}
+    />
+  );
 }
 
 function EditReviewBlock({
   productId,
   initial,
+  photos,
+  existingPhotos,
   onDeleted,
 }: {
   productId: string;
   initial: ProductReview;
+  photos: PhotoPolicy;
+  existingPhotos: ReviewPhotoUpload[];
   onDeleted: () => void;
 }) {
   const [deleting, setDeleting] = useState(false);
@@ -150,6 +181,8 @@ function EditReviewBlock({
         mode="edit"
         initialRating={initial.rating}
         initialBody={initial.body ?? ''}
+        photos={photos}
+        initialPhotos={existingPhotos}
       />
       <div className="flex items-center gap-2">
         <p>{t('startOver')}</p>
@@ -172,11 +205,15 @@ function ReviewEditor({
   mode,
   initialRating,
   initialBody,
+  photos,
+  initialPhotos,
 }: {
   productId: string;
   mode: 'create' | 'edit';
   initialRating: number;
   initialBody: string;
+  photos: PhotoPolicy;
+  initialPhotos: ReviewPhotoUpload[];
 }) {
   const [rating, setRating] = useState(initialRating);
   const t = useTranslations('reviews');
@@ -184,6 +221,34 @@ function ReviewEditor({
   const [submitting, setSubmitting] = useState(false);
   const [error, setError] = useState<string | null>(null);
   const [success, setSuccess] = useState(false);
+  const [uploads, setUploads] = useState<ReviewPhotoUpload[]>(initialPhotos);
+  const [uploading, setUploading] = useState(false);
+  const roomLeft = photos.maxPerReview - uploads.length;
+
+  async function handleFiles(event: React.ChangeEvent<HTMLInputElement>) {
+    const picked = Array.from(event.target.files ?? []);
+    // Reset the input so picking the same file twice still fires a change event.
+    event.target.value = '';
+    if (picked.length === 0) return;
+
+    const tooBig = picked.some((file) => file.size > photos.maxBytes);
+    const accepted = picked.filter((file) => file.size <= photos.maxBytes).slice(0, roomLeft);
+    if (tooBig) setError(t('photoTooLarge'));
+
+    if (accepted.length === 0) return;
+    setUploading(true);
+    try {
+      const done = await Promise.all(
+        accepted.map((file) => getClient().uploadReviewPhoto(productId, file))
+      );
+      setUploads((prev) => [...prev, ...done]);
+      if (!tooBig) setError(null);
+    } catch {
+      setError(t('photoUploadFailed'));
+    } finally {
+      setUploading(false);
+    }
+  }
 
   async function handleSubmit(event: React.FormEvent<HTMLFormElement>) {
     event.preventDefault();
@@ -191,7 +256,13 @@ function ReviewEditor({
     setSubmitting(true);
     try {
       const client = getClient();
-      const input = { rating, body: body.trim() || undefined };
+      // imageKeys REPLACES the photo set, so send every key we still want. Keys,
+      // never urls — the url on an upload is only good for the local preview.
+      const input = {
+        rating,
+        body: body.trim() || undefined,
+        ...(photos.enabled ? { imageKeys: uploads.map((upload) => upload.key) } : {}),
+      };
       if (mode === 'edit') {
         await client.updateMyProductReview(productId, input);
       } else {
@@ -251,9 +322,56 @@ function ReviewEditor({
         />
       </label>
 
+      {/* DESIGN ME — review photo picker. Renders only when the store allows
+          photos; every limit comes from `photos`, never hard-coded. */}
+      {photos.enabled && (
+        <fieldset>
+          <legend>
+            {t('addPhotos')} ({uploads.length}/{photos.maxPerReview})
+          </legend>
+
+          {uploads.length > 0 && (
+            <ul>
+              {uploads.map((upload) => (
+                <li key={upload.key}>
+                  <img
+                    src={upload.url}
+                    alt=""
+                    width={upload.width ?? undefined}
+                    height={upload.height ?? undefined}
+                  />
+                  <button
+                    type="button"
+                    onClick={() =>
+                      setUploads((prev) => prev.filter((item) => item.key !== upload.key))
+                    }
+                    aria-label={t('removePhoto')}
+                  >
+                    &times;
+                  </button>
+                </li>
+              ))}
+            </ul>
+          )}
+
+          <input
+            type="file"
+            accept="image/jpeg,image/png,image/webp,image/gif"
+            multiple
+            disabled={uploading || roomLeft <= 0}
+            onChange={handleFiles}
+          />
+
+          {uploading && <p>{t('photoUploading')}</p>}
+          {/* Said BEFORE they submit: a shopper who uploads, submits, and cannot
+              find their photo will conclude the site is broken. */}
+          {photos.requiresApproval && <p>{t('photosNeedApproval')}</p>}
+        </fieldset>
+      )}
+
       {error && <p role="alert">{error}</p>}
 
-      <button type="submit" disabled={submitting}>
+      <button type="submit" disabled={submitting || uploading}>
         {submitting
           ? mode === 'edit'
             ? t('saving')

package/templates/nextjs/ui-canvas/product/reviews-section.tsx.ejs

@@ -1,96 +1,127 @@
-import type { ProductReview } from 'brainerce';
-import { getServerClient } from '@/core/lib/brainerce.server';
-<% if (i18nEnabled) { %>import { getMessages, defaultLocale } from '@/i18n';<% } else { %>import { defaultLocale, messages } from '@/i18n';<% } %>
-import { ReviewForm } from './review-form';
-
-// Server component — it renders before any client i18n context exists, so the
-// wrapper strings (title / empty state / verified badge) are read straight
-// from the `reviews` namespace in messages/, keyed by the store locale.
-type ReviewStrings = Record<string, string>;
-
-<% if (i18nEnabled) { %>async function getReviewStrings(locale: string): Promise<ReviewStrings> {
-  return ((await getMessages(locale)).reviews ?? {}) as ReviewStrings;
-}<% } else { %>async function getReviewStrings(_locale: string): Promise<ReviewStrings> {
-  return messages.reviews as ReviewStrings;
-}<% } %>
-
-interface ReviewsSectionProps {
-  productId: string;
-  initialReviews?: ProductReview[];
-  locale?: string;
-  /** Where to send users back to after submit (defaults to the current product URL). */
-  returnUrl?: string;
-}
-
-/**
- * Renders the visible reviews for a product plus a submit form.
- *
- * Server component — fetches with the SDK on the server so reviews are in
- * the initial HTML payload (good for SEO; JSON-LD on the same page already
- * carries `aggregateRating` when reviewCount > 0).
- */
-export async function ReviewsSection({
-  productId,
-  initialReviews,
-  locale = defaultLocale,
-}: ReviewsSectionProps) {
-  const t = await getReviewStrings(locale);
-  let reviews: ProductReview[] = initialReviews ?? [];
-
-  if (!initialReviews) {
-    try {
-      const result = await (await getServerClient()).listProductReviews(productId, { page: 1, limit: 20 });
-      reviews = result.data;
-    } catch {
-      // Review listing disabled at store level or network error — render the form anyway.
-      reviews = [];
-    }
-  }
-
-  return (
-    <section aria-labelledby="reviews-heading">
-      {/* DESIGN ME — product reviews: server-fetched review list (SDK listProductReviews) + eligibility-aware submit form. Compose with the shadcn/ui primitives in src/components/ui (Button, Card, Badge, Input, Select, Accordion, Dialog, Skeleton, ...) + lucide-react icons. */}
-      <h2 id="reviews-heading">{t.title}</h2>
-
-      {reviews.length === 0 ? (
-        <p>{t.noReviews}</p>
-      ) : (
-        <ul>
-          {reviews.map((review) => (
-            <ReviewCard key={review.id} review={review} verifiedLabel={t.verifiedPurchase} />
-          ))}
-        </ul>
-      )}
-
-      <ReviewForm productId={productId} />
-    </section>
-  );
-}
-
-function ReviewCard({ review, verifiedLabel }: { review: ProductReview; verifiedLabel: string }) {
-  return (
-    <li>
-      <article>
-        <header className="flex flex-wrap items-center gap-2">
-          <Stars rating={review.rating} />
-          <span>{review.authorName}</span>
-          {review.verifiedPurchase && <span>{verifiedLabel}</span>}
-          <time dateTime={review.createdAt}>{new Date(review.createdAt).toLocaleDateString()}</time>
-        </header>
-        {review.body && <p className="whitespace-pre-line break-words">{review.body}</p>}
-      </article>
-    </li>
-  );
-}
-
-function Stars({ rating }: { rating: number }) {
-  return (
-    <span aria-label={`${rating} of 5 stars`}>
-      {[1, 2, 3, 4, 5].map((n) => (
-        <span key={n} aria-hidden="true">
-          {n <= rating ? '★' : '☆'}
-        </span>
-      ))}
-    </span>
-  );
-}
+import type { ProductReview } from 'brainerce';
+import { getServerClient } from '@/core/lib/brainerce.server';
+import { CdnImage } from '@/ui/shared/cdn-image';
+<% if (i18nEnabled) { %>import { getMessages, defaultLocale } from '@/i18n';<% } else { %>import { defaultLocale, messages } from '@/i18n';<% } %>
+import { ReviewForm } from './review-form';
+
+// Server component — it renders before any client i18n context exists, so the
+// wrapper strings (title / empty state / verified badge) are read straight
+// from the `reviews` namespace in messages/, keyed by the store locale.
+type ReviewStrings = Record<string, string>;
+
+<% if (i18nEnabled) { %>async function getReviewStrings(locale: string): Promise<ReviewStrings> {
+  return ((await getMessages(locale)).reviews ?? {}) as ReviewStrings;
+}<% } else { %>async function getReviewStrings(_locale: string): Promise<ReviewStrings> {
+  return messages.reviews as ReviewStrings;
+}<% } %>
+
+interface ReviewsSectionProps {
+  productId: string;
+  initialReviews?: ProductReview[];
+  locale?: string;
+  /** Where to send users back to after submit (defaults to the current product URL). */
+  returnUrl?: string;
+}
+
+/**
+ * Renders the visible reviews for a product plus a submit form.
+ *
+ * Server component — fetches with the SDK on the server so reviews are in
+ * the initial HTML payload (good for SEO; JSON-LD on the same page already
+ * carries `aggregateRating` when reviewCount > 0).
+ */
+export async function ReviewsSection({
+  productId,
+  initialReviews,
+  locale = defaultLocale,
+}: ReviewsSectionProps) {
+  const t = await getReviewStrings(locale);
+  let reviews: ProductReview[] = initialReviews ?? [];
+
+  if (!initialReviews) {
+    try {
+      const result = await (await getServerClient()).listProductReviews(productId, { page: 1, limit: 20, sort: 'photos_first' });
+      reviews = result.data;
+    } catch {
+      // Review listing disabled at store level or network error — render the form anyway.
+      reviews = [];
+    }
+  }
+
+  return (
+    <section aria-labelledby="reviews-heading">
+      {/* DESIGN ME — product reviews: server-fetched review list (SDK listProductReviews) + eligibility-aware submit form. Compose with the shadcn/ui primitives in src/components/ui (Button, Card, Badge, Input, Select, Accordion, Dialog, Skeleton, ...) + lucide-react icons. */}
+      <h2 id="reviews-heading">{t.title}</h2>
+
+      {reviews.length === 0 ? (
+        <p>{t.noReviews}</p>
+      ) : (
+        <ul>
+          {reviews.map((review) => (
+            <ReviewCard key={review.id} review={review} verifiedLabel={t.verifiedPurchase} />
+          ))}
+        </ul>
+      )}
+
+      <ReviewForm productId={productId} />
+    </section>
+  );
+}
+
+function ReviewCard({ review, verifiedLabel }: { review: ProductReview; verifiedLabel: string }) {
+  return (
+    <li>
+      <article>
+        <header className="flex flex-wrap items-center gap-2">
+          <Stars rating={review.rating} />
+          <span>{review.authorName}</span>
+          {review.verifiedPurchase && <span>{verifiedLabel}</span>}
+          <time dateTime={review.createdAt}>{new Date(review.createdAt).toLocaleDateString()}</time>
+        </header>
+        {review.body && <p className="whitespace-pre-line break-words">{review.body}</p>}
+        <ReviewPhotos review={review} />
+      </article>
+    </li>
+  );
+}
+
+/**
+ * Photos the reviewer attached. `review.images` is always an array and already
+ * carries only what shoppers are allowed to see, so there is nothing to filter.
+ *
+ * The intrinsic width/height come back from the API — passing them through is
+ * what stops the page jumping as the photos load.
+ */
+function ReviewPhotos({ review }: { review: ProductReview }) {
+  if (review.images.length === 0) return null;
+
+  return (
+    <ul className="mt-3 flex flex-wrap gap-2">
+      {review.images.map((image) => (
+        <li key={image.id}>
+          <a href={image.url} target="_blank" rel="noopener noreferrer">
+            <CdnImage
+              src={image.thumbnailUrl ?? image.url}
+              alt=""
+              width={image.width ?? 96}
+              height={image.height ?? 96}
+              className="h-24 w-24 rounded-md border object-cover"
+            />
+          </a>
+        </li>
+      ))}
+    </ul>
+  );
+}
+
+function Stars({ rating }: { rating: number }) {
+  return (
+    <span aria-label={`${rating} of 5 stars`}>
+      {[1, 2, 3, 4, 5].map((n) => (
+        <span key={n} aria-hidden="true">
+          {n <= rating ? '★' : '☆'}
+        </span>
+      ))}
+    </span>
+  );
+}