@brainerce/mcp-server 3.6.0 → 3.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/bin/stdio.js CHANGED
@@ -922,6 +922,175 @@ function ProductPage({ product, storeInfo }: { product: Product; storeInfo: Stor
922
922
  }
923
923
  \`\`\`
924
924
 
925
+ ### Variant Attribute Selector with Swatches (color + size **mix**)
926
+
927
+ The simple text-button picker above works, but loses the merchant-configured
928
+ **swatch metadata**. A single product often mixes one attribute that should
929
+ render as **color swatches** (e.g. \`Color\`) and another that should render
930
+ as **text buttons** (e.g. \`Size\`). The product response includes everything
931
+ you need:
932
+
933
+ - \`product.productAttributeOptions[]\` \u2014 the swatch definitions: \`attribute.name\`,
934
+ \`attribute.displayType\` (the \`AttributeDisplayType\` enum: \`DEFAULT\` | \`COLOR_SWATCH\` | \`IMAGE_SWATCH\` | \`MIXED_SWATCH\`),
935
+ \`attributeOption.name\`, \`swatchColor\` (hex), \`swatchColor2\` (hex \u2014 used for dual-color swatches
936
+ like Black & White), \`swatchImageUrl\` (for fabric / pattern thumbnails).
937
+ \`MIXED_SWATCH\` means each option in the group can independently pick image OR color
938
+ (the merchant decides per option). Treat any unrecognized value as \`DEFAULT\`.
939
+ - \`variant.attributes\` \u2014 the selected value per attribute on each variant.
940
+
941
+ Use \`getProductSwatches(product)\` to get a render-ready, grouped structure:
942
+
943
+ \`\`\`typescript
944
+ import { getProductSwatches } from 'brainerce';
945
+
946
+ const groups = getProductSwatches(product);
947
+ // [
948
+ // { attributeName: 'color', displayType: 'COLOR_SWATCH', options: [
949
+ // { name: 'Full Color', swatchColor: '#1D9435', swatchColor2: null, swatchImageUrl: null },
950
+ // { name: 'Black & White', swatchColor: '#000000', swatchColor2: '#FFFFFF', swatchImageUrl: null },
951
+ // ]},
952
+ // { attributeName: 'size', displayType: 'DEFAULT', options: [
953
+ // { name: '16" \xD7 20"' }, { name: '24" \xD7 32"' }, { name: '36" \xD7 48"' },
954
+ // ]},
955
+ // ]
956
+ \`\`\`
957
+
958
+ Render one branch per \`displayType\`. The same loop handles all-swatch, all-text,
959
+ and the mix case:
960
+
961
+ \`\`\`typescript
962
+ function VariantPicker({
963
+ product,
964
+ selections,
965
+ onSelect,
966
+ }: {
967
+ product: Product;
968
+ selections: Record<string, string>; // { color: 'Full Color', size: '24" \xD7 32"' }
969
+ onSelect: (attrName: string, value: string) => void;
970
+ }) {
971
+ const groups = getProductSwatches(product);
972
+ if (groups.length === 0) return null;
973
+
974
+ return (
975
+ <div className="space-y-4">
976
+ {groups.map((group) => (
977
+ <div key={group.attributeName}>
978
+ <label className="block mb-2 text-sm font-medium">
979
+ {group.attributeName}: <span className="text-gray-500">{selections[group.attributeName] ?? ''}</span>
980
+ </label>
981
+ <div className="flex flex-wrap gap-2">
982
+ {group.options.map((opt) => {
983
+ const isSelected = selections[group.attributeName] === opt.name;
984
+
985
+ // COLOR_SWATCH \u2014 round button; dual-color uses a 50/50 gradient.
986
+ if (group.displayType === 'COLOR_SWATCH' && opt.swatchColor) {
987
+ const bg = opt.swatchColor2
988
+ ? \`linear-gradient(135deg, \${opt.swatchColor} 50%, \${opt.swatchColor2} 50%)\`
989
+ : opt.swatchColor;
990
+ return (
991
+ <button
992
+ key={opt.name}
993
+ type="button"
994
+ title={opt.name}
995
+ aria-pressed={isSelected}
996
+ onClick={() => onSelect(group.attributeName, opt.name)}
997
+ className={\`h-9 w-9 rounded-full border-2 \${isSelected ? 'border-black ring-2 ring-black/30' : 'border-gray-300 hover:border-black'}\`}
998
+ style={{ background: bg }}
999
+ />
1000
+ );
1001
+ }
1002
+
1003
+ // IMAGE_SWATCH \u2014 square thumbnail (fabric/pattern preview).
1004
+ if (group.displayType === 'IMAGE_SWATCH' && opt.swatchImageUrl) {
1005
+ return (
1006
+ <button
1007
+ key={opt.name}
1008
+ type="button"
1009
+ aria-pressed={isSelected}
1010
+ onClick={() => onSelect(group.attributeName, opt.name)}
1011
+ className={\`h-10 w-10 overflow-hidden rounded border-2 \${isSelected ? 'border-black' : 'border-gray-300'}\`}
1012
+ >
1013
+ <img src={opt.swatchImageUrl} alt={opt.name} className="h-full w-full object-cover" />
1014
+ </button>
1015
+ );
1016
+ }
1017
+
1018
+ // MIXED_SWATCH \u2014 each option is independently image OR color (image wins if present).
1019
+ if (group.displayType === 'MIXED_SWATCH') {
1020
+ if (opt.swatchImageUrl) {
1021
+ return (
1022
+ <button
1023
+ key={opt.name}
1024
+ type="button"
1025
+ aria-pressed={isSelected}
1026
+ onClick={() => onSelect(group.attributeName, opt.name)}
1027
+ className={\`h-10 w-10 overflow-hidden rounded border-2 \${isSelected ? 'border-black' : 'border-gray-300'}\`}
1028
+ >
1029
+ <img src={opt.swatchImageUrl} alt={opt.name} className="h-full w-full object-cover" />
1030
+ </button>
1031
+ );
1032
+ }
1033
+ if (opt.swatchColor) {
1034
+ const bg = opt.swatchColor2
1035
+ ? \`linear-gradient(135deg, \${opt.swatchColor} 50%, \${opt.swatchColor2} 50%)\`
1036
+ : opt.swatchColor;
1037
+ return (
1038
+ <button
1039
+ key={opt.name}
1040
+ type="button"
1041
+ title={opt.name}
1042
+ aria-pressed={isSelected}
1043
+ onClick={() => onSelect(group.attributeName, opt.name)}
1044
+ className={\`h-9 w-9 rounded-full border-2 \${isSelected ? 'border-black ring-2 ring-black/30' : 'border-gray-300 hover:border-black'}\`}
1045
+ style={{ background: bg }}
1046
+ />
1047
+ );
1048
+ }
1049
+ // option has neither image nor color \u2192 fall through to text button below.
1050
+ }
1051
+
1052
+ // DEFAULT (or any swatch type missing its data) \u2014 plain text button.
1053
+ return (
1054
+ <button
1055
+ key={opt.name}
1056
+ type="button"
1057
+ aria-pressed={isSelected}
1058
+ onClick={() => onSelect(group.attributeName, opt.name)}
1059
+ className={\`rounded border px-3 py-1.5 text-sm \${isSelected ? 'bg-black text-white border-black' : 'border-gray-300 hover:border-black'}\`}
1060
+ >
1061
+ {opt.name}
1062
+ </button>
1063
+ );
1064
+ })}
1065
+ </div>
1066
+ </div>
1067
+ ))}
1068
+ </div>
1069
+ );
1070
+ }
1071
+ \`\`\`
1072
+
1073
+ Wire it up in the product page: keep \`selections\` in state, find the matching
1074
+ variant after each pick, and update price / image / stock from it.
1075
+
1076
+ \`\`\`typescript
1077
+ const [selections, setSelections] = useState<Record<string, string>>({});
1078
+
1079
+ const matchedVariant = useMemo(() => (
1080
+ product.variants?.find((v) =>
1081
+ Object.entries(selections).every(([k, val]) => v.attributes?.[k] === val)
1082
+ ) ?? null
1083
+ ), [product.variants, selections]);
1084
+
1085
+ // Greying-out unavailable combinations: for each candidate value, run
1086
+ // the same find() and check \`inventory.canPurchase\`. Disable the button
1087
+ // if no purchasable variant exists under that selection.
1088
+ \`\`\`
1089
+
1090
+ **i18n:** \`getProductSwatches\` returns translated \`attributeName\` and
1091
+ \`option.name\` automatically when \`client.setLocale()\` is active. No
1092
+ client-side overlay needed. Swatch colors are language-agnostic.
1093
+
925
1094
  ### Description Rendering (handles HTML vs text)
926
1095
 
927
1096
  \`\`\`typescript
@@ -1556,17 +1725,28 @@ Allergens (informational chips), scheduled availability windows, nested combos (
1556
1725
  function getProductReviewsSection() {
1557
1726
  return `## Product Reviews (\u2605 ratings + JSON-LD for SEO)
1558
1727
 
1559
- Reviews publish immediately on submit. Merchants hide individual reviews via the admin surface \u2014 no PENDING queue.
1728
+ **Purchaser-only.** Only authenticated customers who purchased the product can submit. Each customer writes one review per product and can edit/delete it. Reviews publish immediately \u2014 no PENDING queue.
1560
1729
 
1561
1730
  \`\`\`typescript
1562
- // PDP \u2014 list visible reviews
1563
- const { data, meta } = await client.listProductReviews(productId, { page: 1, limit: 20 });
1564
- data.forEach(r => render(r.authorName, r.rating, r.body, r.verifiedPurchase));
1731
+ // PDP \u2014 list visible reviews (public)
1732
+ const { data } = await getClient().listProductReviews(productId, { page: 1, limit: 20 });
1733
+
1734
+ // Decide which UI to render for the current customer
1735
+ getClient().setCustomerToken(authToken); // after login
1736
+ const { eligible, reason, myReview } = await getClient().getMyProductReview(productId);
1737
+
1738
+ if (!eligible) {
1739
+ // reason: 'no_eligible_order' | 'reviews_disabled' | 'product_not_found'
1740
+ // \u2192 "only customers who purchased this product can leave a review"
1741
+ } else if (myReview) {
1742
+ // \u2192 edit form prefilled with myReview.rating + myReview.body
1743
+ } else {
1744
+ // \u2192 submit form (rating + body only \u2014 name/email come from customer profile)
1745
+ }
1565
1746
 
1566
- // PDP \u2014 submit form
1567
- await client.submitProductReview(productId, {
1568
- authorName, authorEmail, rating: 5, body,
1569
- });
1747
+ await getClient().submitProductReview(productId, { rating: 5, body: 'Loved it!' });
1748
+ await getClient().updateMyProductReview(productId, { rating: 4, body: 'Updated.' });
1749
+ await getClient().deleteMyProductReview(productId); // can submit a new one after
1570
1750
  \`\`\`
1571
1751
 
1572
1752
  Each \`Product\` carries denormalized rollups: \`product.avgRating\`, \`product.reviewCount\`. Use these on PLP cards.
@@ -1595,9 +1775,10 @@ const productJsonLd = {
1595
1775
 
1596
1776
  ### Rules
1597
1777
  - Rating must be an integer 1-5 (DB constraint).
1598
- - Duplicate from same email \u2192 409 Conflict.
1599
- - Submit endpoint is throttled to 3 / 60s / IP \u2014 surface a friendly "please wait" on 429.
1600
- - \`verifiedPurchase\` is derived server-side from DELIVERED orders \u2014 DO NOT try to set it.
1778
+ - Customer must be logged in AND have purchased the product (\`SHIPPED+\` for physical, \`PAID+\` for downloadable).
1779
+ - One review per (productId, customerId). Duplicate submit \u2192 409 \u2014 use updateMyProductReview instead.
1780
+ - Submit throttled 3 / 60s / IP; edit/delete 5 / 60s / IP.
1781
+ - \`verifiedPurchase\` is always true for customer-submitted reviews.
1601
1782
  - Stores with \`reviewsEnabled = false\` return 403 on storefront endpoints.`;
1602
1783
  }
1603
1784
  function getInventorySection() {
@@ -2693,9 +2874,7 @@ var GET_SDK_DOCS_SCHEMA = {
2693
2874
  async function handleGetSdkDocs(args) {
2694
2875
  const id = args.salesChannelId ?? args.connectionId;
2695
2876
  if (!args.salesChannelId && args.connectionId) {
2696
- console.warn(
2697
- "get-sdk-docs: `connectionId` is deprecated \u2014 use `salesChannelId` instead"
2698
- );
2877
+ console.warn("get-sdk-docs: `connectionId` is deprecated \u2014 use `salesChannelId` instead");
2699
2878
  }
2700
2879
  const content = getSectionByTopic(args.topic, id, args.currency);
2701
2880
  return {
@@ -3427,11 +3606,16 @@ interface ProductReviewAdmin extends ProductReview {
3427
3606
  updatedAt: string;
3428
3607
  }
3429
3608
 
3430
- interface SubmitProductReviewInput {
3431
- authorName: string;
3432
- authorEmail?: string; // recommended \u2014 used for guest dedupe + verified-purchase derivation
3609
+ interface WriteProductReviewInput {
3433
3610
  rating: number; // 1-5
3434
- body?: string; // optional
3611
+ body?: string; // optional, max 5000 chars
3612
+ }
3613
+
3614
+ interface MyProductReview {
3615
+ eligible: boolean;
3616
+ // Machine-readable reason when not eligible. null when eligible=true.
3617
+ reason: 'no_eligible_order' | 'reviews_disabled' | 'product_not_found' | null;
3618
+ myReview: ProductReview | null;
3435
3619
  }
3436
3620
 
3437
3621
  // Each Product carries denormalized review stats:
@@ -3734,6 +3918,7 @@ var GET_CODE_EXAMPLE_SCHEMA = {
3734
3918
  "sdk-init",
3735
3919
  "cart-read-and-mutate",
3736
3920
  "variant-selection",
3921
+ "variant-selector-swatches",
3737
3922
  "checkout-address-and-shipping",
3738
3923
  "checkout-payment-providers",
3739
3924
  "checkout-stripe-confirm",
@@ -3803,28 +3988,148 @@ for (const item of cart.items) {
3803
3988
  const unitPrice = parseFloat(item.unitPrice); // prices are strings!
3804
3989
  }`,
3805
3990
  "variant-selection": `// Variant selection with live stock + price updates.
3991
+ // Variants expose attributes as a flat object: { color: 'Red', size: 'M' }.
3992
+ // NOT 'options' \u2014 that field does not exist on ProductVariant.
3806
3993
  import { getVariantPrice, getStockStatus, getVariantOptions } from 'brainerce';
3807
3994
  import type { Product, ProductVariant } from 'brainerce';
3808
3995
 
3809
3996
  function selectVariant(product: Product, selections: Record<string, string>) {
3810
- // selections = { Size: 'M', Color: 'Red' }
3811
- const variant = product.variants.find((v) =>
3812
- v.options.every((o) => selections[o.name] === o.value)
3997
+ // selections = { size: 'M', color: 'Red' } (keys match variant.attributes keys)
3998
+ const variant = product.variants?.find((v) =>
3999
+ Object.entries(selections).every(([k, val]) => v.attributes?.[k] === val)
3813
4000
  );
3814
4001
  if (!variant) return null;
3815
4002
 
3816
- const price = getVariantPrice(product, variant); // handles compare-at, currency
3817
- const stock = getStockStatus(variant); // 'IN_STOCK' | 'LOW_STOCK' | 'OUT_OF_STOCK'
3818
- const canPurchase = stock !== 'OUT_OF_STOCK';
4003
+ const price = getVariantPrice(variant, product.basePrice); // string, fallback-aware
4004
+ const stock = getStockStatus(variant.inventory); // 'in-stock' | 'low-stock' | 'out-of-stock' | 'unavailable'
4005
+ const canPurchase = variant.inventory?.canPurchase !== false;
3819
4006
 
3820
4007
  // Switch the main product image to the variant's image if it has one
3821
- const image = variant.image ?? product.images[0];
4008
+ const image = variant.image ?? product.images?.[0];
3822
4009
 
3823
4010
  return { variant, price, stock, canPurchase, image };
3824
4011
  }
3825
4012
 
3826
- // Build the option picker from getVariantOptions(product) \u2014 returns
3827
- // [{ name: 'Size', values: ['S','M','L'] }, ...]`,
4013
+ // Build the option picker by iterating product.variants and grouping
4014
+ // variant.attributes into { color: ['Red', 'Blue'], size: ['S','M','L'] }.
4015
+ // For each variant you can also call getVariantOptions(variant) which returns
4016
+ // the same key/value pairs as an array with translated names when setLocale() is active.
4017
+ // For swatch metadata (color hex, dual-color, image), use the
4018
+ // 'variant-selector-swatches' operation instead.`,
4019
+ "variant-selector-swatches": `// Variant picker that mixes color swatches and text buttons in one product.
4020
+ // Uses product.productAttributeOptions[] \u2014 the merchant-configured swatch
4021
+ // metadata. displayType is the AttributeDisplayType Prisma enum, one of:
4022
+ // 'DEFAULT' \u2014 plain text button
4023
+ // 'COLOR_SWATCH' \u2014 swatchColor (+ optional swatchColor2 dual-color gradient)
4024
+ // 'IMAGE_SWATCH' \u2014 swatchImageUrl thumbnail
4025
+ // 'MIXED_SWATCH' \u2014 per-option hybrid: image if swatchImageUrl is set,
4026
+ // otherwise fall back to swatchColor
4027
+ // getProductSwatches() groups options by attribute name so you can render each
4028
+ // attribute with its own displayType \u2014 a single product can have Color as
4029
+ // swatches AND Size as text buttons.
4030
+ import { getProductSwatches } from 'brainerce';
4031
+ import type { Product } from 'brainerce';
4032
+
4033
+ function VariantPicker({
4034
+ product,
4035
+ selections,
4036
+ onSelect,
4037
+ }: {
4038
+ product: Product;
4039
+ selections: Record<string, string>;
4040
+ onSelect: (attrName: string, value: string) => void;
4041
+ }) {
4042
+ const groups = getProductSwatches(product);
4043
+ // groups: [{ attributeName, displayType, options: [{ name, swatchColor, swatchColor2, swatchImageUrl }] }]
4044
+
4045
+ return (
4046
+ <>
4047
+ {groups.map((group) => (
4048
+ <div key={group.attributeName}>
4049
+ <label>{group.attributeName}: {selections[group.attributeName] ?? ''}</label>
4050
+ <div style={{ display: 'flex', gap: 8 }}>
4051
+ {group.options.map((opt) => {
4052
+ const selected = selections[group.attributeName] === opt.name;
4053
+ const onClick = () => onSelect(group.attributeName, opt.name);
4054
+
4055
+ // COLOR_SWATCH: round button. swatchColor2 = dual-color gradient.
4056
+ if (group.displayType === 'COLOR_SWATCH' && opt.swatchColor) {
4057
+ const bg = opt.swatchColor2
4058
+ ? \`linear-gradient(135deg, \${opt.swatchColor} 50%, \${opt.swatchColor2} 50%)\`
4059
+ : opt.swatchColor;
4060
+ return (
4061
+ <button
4062
+ key={opt.name}
4063
+ type="button"
4064
+ title={opt.name}
4065
+ aria-pressed={selected}
4066
+ onClick={onClick}
4067
+ style={{
4068
+ width: 36,
4069
+ height: 36,
4070
+ borderRadius: '50%',
4071
+ background: bg,
4072
+ outline: selected ? '2px solid black' : 'none',
4073
+ }}
4074
+ />
4075
+ );
4076
+ }
4077
+
4078
+ // IMAGE_SWATCH: square thumbnail.
4079
+ if (group.displayType === 'IMAGE_SWATCH' && opt.swatchImageUrl) {
4080
+ return (
4081
+ <button key={opt.name} type="button" onClick={onClick} aria-pressed={selected}>
4082
+ <img src={opt.swatchImageUrl} alt={opt.name} width={40} height={40} />
4083
+ </button>
4084
+ );
4085
+ }
4086
+
4087
+ // MIXED_SWATCH: per-option hybrid (image wins if present).
4088
+ if (group.displayType === 'MIXED_SWATCH') {
4089
+ if (opt.swatchImageUrl) {
4090
+ return (
4091
+ <button key={opt.name} type="button" onClick={onClick} aria-pressed={selected}>
4092
+ <img src={opt.swatchImageUrl} alt={opt.name} width={40} height={40} />
4093
+ </button>
4094
+ );
4095
+ }
4096
+ if (opt.swatchColor) {
4097
+ const bg = opt.swatchColor2
4098
+ ? \`linear-gradient(135deg, \${opt.swatchColor} 50%, \${opt.swatchColor2} 50%)\`
4099
+ : opt.swatchColor;
4100
+ return (
4101
+ <button
4102
+ key={opt.name}
4103
+ type="button"
4104
+ title={opt.name}
4105
+ aria-pressed={selected}
4106
+ onClick={onClick}
4107
+ style={{ width: 36, height: 36, borderRadius: '50%', background: bg }}
4108
+ />
4109
+ );
4110
+ }
4111
+ }
4112
+
4113
+ // DEFAULT (or any swatch type missing its data): text button.
4114
+ return (
4115
+ <button key={opt.name} type="button" onClick={onClick} aria-pressed={selected}>
4116
+ {opt.name}
4117
+ </button>
4118
+ );
4119
+ })}
4120
+ </div>
4121
+ </div>
4122
+ ))}
4123
+ </>
4124
+ );
4125
+ }
4126
+
4127
+ // After the user picks a value, find the matching ProductVariant:
4128
+ // product.variants?.find((v) =>
4129
+ // Object.entries(selections).every(([k, val]) => v.attributes?.[k] === val)
4130
+ // )
4131
+ // Then read variant.price, variant.image, variant.inventory.canPurchase
4132
+ // to update the rest of the PDP.`,
3828
4133
  "checkout-address-and-shipping": `// Step 1-3 of the checkout flow. Never reorder or skip.
3829
4134
  import { client } from './brainerce';
3830
4135
 
@@ -4617,21 +4922,25 @@ function renderCartItem(item: CartItem): string {
4617
4922
  function lineTotal(item: CartItem): number {
4618
4923
  return item.unitPrice * item.quantity;
4619
4924
  }`,
4620
- "product-reviews": `// PDP: list visible reviews + submit form + JSON-LD aggregateRating
4621
- import { client } from '@/lib/brainerce';
4622
- import type { Product, ProductReview, SubmitProductReviewInput } from 'brainerce';
4623
-
4925
+ "product-reviews": `// Purchaser-only reviews. Customer must be logged in AND have purchased
4926
+ // the product. The component switches between sign-in CTA / not-eligible /
4927
+ // submit form / edit form based on getMyProductReview().
4928
+ import { getClient, getServerClient } from '@/lib/brainerce';
4929
+ import { checkAuthStatus } from '@/lib/auth';
4930
+ import type { Product, ProductReview, MyProductReview } from 'brainerce';
4931
+
4932
+ // Server component \u2014 fetches existing reviews + emits JSON-LD aggregateRating.
4624
4933
  export async function ProductReviewsSection({ product }: { product: Product }) {
4625
- const { data } = await client.listProductReviews(product.id, { page: 1, limit: 20 });
4934
+ const { data } = await getServerClient().listProductReviews(product.id, { page: 1, limit: 20 });
4626
4935
 
4627
4936
  return (
4628
4937
  <section>
4629
4938
  <h2>Reviews ({product.reviewCount ?? 0})</h2>
4630
- {data.length === 0 && <p>No reviews yet \u2014 be the first.</p>}
4939
+ {data.length === 0 && <p>No reviews yet.</p>}
4631
4940
  {data.map((r) => (
4632
4941
  <article key={r.id}>
4633
4942
  <strong>{r.authorName}</strong>
4634
- {r.verifiedPurchase && <span> \xB7 Verified</span>}
4943
+ {r.verifiedPurchase && <span> \xB7 Verified purchase</span>}
4635
4944
  <div>{'\u2605'.repeat(r.rating)}{'\u2606'.repeat(5 - r.rating)}</div>
4636
4945
  {r.body && <p>{r.body}</p>}
4637
4946
  </article>
@@ -4664,42 +4973,83 @@ function productJsonLd(product: Product, url: string) {
4664
4973
 
4665
4974
  // Client-side form
4666
4975
  'use client';
4667
- import { useState } from 'react';
4976
+ import { useEffect, useState } from 'react';
4977
+
4978
+ type Stage =
4979
+ | { kind: 'loading' }
4980
+ | { kind: 'signed_out' }
4981
+ | { kind: 'not_eligible'; reason: MyProductReview['reason'] }
4982
+ | { kind: 'submit' }
4983
+ | { kind: 'edit'; review: ProductReview };
4668
4984
 
4669
4985
  function ReviewForm({ productId }: { productId: string }) {
4986
+ const [stage, setStage] = useState<Stage>({ kind: 'loading' });
4670
4987
  const [rating, setRating] = useState(5);
4671
4988
  const [body, setBody] = useState('');
4672
- const [name, setName] = useState('');
4673
- const [email, setEmail] = useState('');
4674
4989
  const [error, setError] = useState<string | null>(null);
4675
4990
 
4991
+ useEffect(() => {
4992
+ (async () => {
4993
+ const auth = await checkAuthStatus();
4994
+ if (!auth.isLoggedIn) return setStage({ kind: 'signed_out' });
4995
+ const me = await getClient().getMyProductReview(productId);
4996
+ if (!me.eligible) return setStage({ kind: 'not_eligible', reason: me.reason });
4997
+ if (me.myReview) {
4998
+ setRating(me.myReview.rating);
4999
+ setBody(me.myReview.body ?? '');
5000
+ return setStage({ kind: 'edit', review: me.myReview });
5001
+ }
5002
+ setStage({ kind: 'submit' });
5003
+ })();
5004
+ }, [productId]);
5005
+
5006
+ if (stage.kind === 'loading') return <p>Loading\u2026</p>;
5007
+ if (stage.kind === 'signed_out')
5008
+ return <p><a href="/account/login">Sign in</a> to leave a review.</p>;
5009
+ if (stage.kind === 'not_eligible')
5010
+ return <p>Only customers who purchased this product can leave a review.</p>;
5011
+
4676
5012
  async function submit(e: React.FormEvent) {
4677
5013
  e.preventDefault();
4678
5014
  setError(null);
5015
+ const client = getClient();
5016
+ const input = { rating, body: body || undefined };
4679
5017
  try {
4680
- await client.submitProductReview(productId, {
4681
- authorName: name,
4682
- authorEmail: email,
4683
- rating,
4684
- body: body || undefined,
4685
- });
5018
+ if (stage.kind === 'edit') {
5019
+ await client.updateMyProductReview(productId, input);
5020
+ } else {
5021
+ await client.submitProductReview(productId, input);
5022
+ }
4686
5023
  window.location.reload();
4687
5024
  } catch (err: any) {
4688
- if (err?.status === 409) setError("You've already reviewed this product.");
5025
+ if (err?.status === 403) setError('Only customers who purchased this product can leave a review.');
5026
+ else if (err?.status === 409) setError('You already reviewed this product.');
4689
5027
  else if (err?.status === 429) setError('Too many submissions. Please wait a moment.');
4690
- else setError('Could not submit review. Please try again.');
5028
+ else setError('Could not save your review. Please try again.');
4691
5029
  }
4692
5030
  }
4693
5031
 
5032
+ async function remove() {
5033
+ if (!confirm('Delete your review?')) return;
5034
+ await getClient().deleteMyProductReview(productId);
5035
+ window.location.reload();
5036
+ }
5037
+
4694
5038
  return (
4695
5039
  <form onSubmit={submit}>
4696
- <input value={name} onChange={(e) => setName(e.target.value)} placeholder="Your name" required maxLength={100} />
4697
- <input type="email" value={email} onChange={(e) => setEmail(e.target.value)} placeholder="Email" />
4698
- <select value={rating} onChange={(e) => setRating(Number(e.target.value))}>
4699
- {[5,4,3,2,1].map(n => <option key={n} value={n}>{'\u2605'.repeat(n)}</option>)}
4700
- </select>
4701
- <textarea value={body} onChange={(e) => setBody(e.target.value)} maxLength={5000} placeholder="Tell us what you think (optional)" />
4702
- <button type="submit">Submit review</button>
5040
+ <h3>{stage.kind === 'edit' ? 'Edit your review' : 'Write a review'}</h3>
5041
+ <div>
5042
+ {[1,2,3,4,5].map(n => (
5043
+ <button type="button" key={n} onClick={() => setRating(n)}>
5044
+ {n <= rating ? '\u2605' : '\u2606'}
5045
+ </button>
5046
+ ))}
5047
+ </div>
5048
+ <textarea value={body} onChange={(e) => setBody(e.target.value)} maxLength={5000} />
5049
+ <button type="submit">{stage.kind === 'edit' ? 'Save changes' : 'Submit review'}</button>
5050
+ {stage.kind === 'edit' && (
5051
+ <button type="button" onClick={remove}>Delete review</button>
5052
+ )}
4703
5053
  {error && <p role="alert">{error}</p>}
4704
5054
  </form>
4705
5055
  );
@@ -5507,9 +5857,9 @@ var FEATURES = [
5507
5857
  },
5508
5858
  {
5509
5859
  id: "product-reviews",
5510
- title: "Display + collect product reviews with stars + JSON-LD",
5511
- description: 'On the PDP show a Reviews section: list of customer reviews with star rating, author name, verified-purchase badge, body, and date. Include a submit form (name + email + 1-5 stars + optional body). On PLP cards show \u2605 avgRating and (reviewCount). Emit Product JSON-LD with aggregateRating ONLY when product.reviewCount > 0 \u2014 this is what unlocks the star rich snippet in Google. Reviews publish immediately; the merchant moderates from the admin surface. Rate-limited to 3 submits / 60s / IP. Show a friendly "you already reviewed this" message on 409.',
5512
- sdk: "client.listProductReviews(productId), client.submitProductReview(productId, { authorName, authorEmail, rating, body }). Product.avgRating + Product.reviewCount are denormalized rollups returned on every product fetch.",
5860
+ title: "Display + collect product reviews (purchaser-only) with stars + JSON-LD",
5861
+ description: 'On the PDP show a Reviews section: list of customer reviews with star rating, author name (from customer profile), verified-purchase badge, body, and date \u2014 public, no login needed. Below the list, a form that adapts to the current customer: signed-in + purchased + no review yet \u2192 submit form (rating 1-5 + optional body, no name/email \u2014 those are derived from the customer profile); signed-in + purchased + already has review \u2192 edit form prefilled with rating/body plus a delete button; signed-in but did NOT purchase \u2192 "only customers who purchased this product can leave a review"; not signed in \u2192 sign-in CTA. Eligibility: physical products require an order in SHIPPED+; downloadable products additionally accept PAID/PROCESSING. On PLP cards show \u2605 avgRating and (reviewCount). Emit Product JSON-LD with aggregateRating ONLY when product.reviewCount > 0 \u2014 this is what unlocks the star rich snippet in Google. Reviews publish immediately; merchants moderate (hide/show) from the admin surface. Rate-limited 3 submits / 60s / IP.',
5862
+ sdk: "client.listProductReviews(productId) for the public list; client.getMyProductReview(productId) for the form-state decision; client.submitProductReview / updateMyProductReview / deleteMyProductReview for the three customer actions. All four customer methods require setCustomerToken(...) after login. Product.avgRating + Product.reviewCount are denormalized rollups returned on every product fetch.",
5513
5863
  mandatory: "mandatory"
5514
5864
  },
5515
5865
  {