@base44/app-plugin-commerce 0.6.11 → 0.6.12

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@base44/app-plugin-commerce",
3
- "version": "0.6.11",
3
+ "version": "0.6.12",
4
4
  "description": "Base44 Commerce plugin — entities, backend functions, shared commerce engine, admin UI and the commerce skill, shipped as copyable source",
5
5
  "keywords": [
6
6
  "base44",
@@ -194,7 +194,7 @@ Build your layout from — all optional, **not one component style**:
194
194
 
195
195
  ⚑ **Never `.map()` the whole list into one grey label/value table** — that is the single most reliable tell of a generated product page. Design the two or three rows that carry *this* catalog's meaning as what they are (a weight set in the display face, a composition as bars, a provenance beside its place); let the rest fall through to the plain row, and don't feel obliged to keep them in one block — a spec can sit under the gallery, beside the price, or inside the description. Branch on `s.key` too where one particular modifier deserves its own treatment regardless of type. ⚑ **Look a spec up with `findSpec(rows, "care")`** (ignores case, spaces, `_`, `-`): meta keys are free text (`care`, `Care`, `Care Instructions`), so `rows.find(s => s.label === "Care")` silently never matches and renders the fallback forever. `[]` means no section at all.
196
196
  - **Breadcrumbs** — from `categories` (`/collection?category_id=${c.id}`); skip on a flat catalog. Ribbons (`productRibbons(product)`) are labels, not breadcrumbs.
197
- - **Reviews, only if the store wants them** — no review UI is a complete outcome (then no star ratings on cards either: an average of nothing is `0`). ⚑ **Both shapes are exact — invented names fail silently** (a 400 naming a field you *did* fill in; blank authors):
197
+ - **Reviews, only if the store wants them** — no review UI is a complete outcome (then no star ratings on cards either: an average of nothing is `0`). ⚑ **Both shapes are exact**entity-style names (`content`, `reviewer_name`) throw on submit and render blank in the list:
198
198
 
199
199
  ```jsx
200
200
  p.reviews // { items, page, per_page, has_next }
@@ -17,7 +17,7 @@ Reviews are **part of the happy path**, not an extra: the backend always shipped
17
17
  Both live on the storefront client in `@/commerce/utils` — in React, `useStorefront()` is that client:
18
18
 
19
19
  - **`getProductReviews(slugOrRef, { page, per_page })`** → `{ items, page, per_page, has_next, average_rating, rating_count }`. The same reviews `get-product` returns — page or refresh the list without re-fetching the page; `useProduct(slug, { reviewsPerPage })` sizes the first one.
20
- - **`submitReview({ product_id, review?, rating?, reviewer?, email? })`** → `{ review_id, status, verified }`. **Text or stars — at least one**: `review` is the body text, `rating` is **1–5 stars** (0 counts as unrated); stars-only and text-only are both valid, only both missing rejects. `reviewer` is the display name. ⚑ **One set of names, both directions** — the payload above, and rows back as `{ id, reviewer, review, rating, verified, created_date }`. They are the API's names, **not** the ProductReview entity's columns: a near-miss (`content`, `text`, `body`, `comment`; `reviewer_name`, `name`, `author`; `reviewer_email`) throws client-side naming the field it should be, rather than being aliased — a store that posts `content` reads `reviewer_name` back too, so a submit patched into working would still render every author blank. It **rejects** with `email_required` | `review_incomplete` (neither text nor stars) | `invalid_rating` | `not_found` — catch it, read `storefrontErrorCode(e)`, and land each code on its own field, so a failed submit says what to fix instead of resolving into nothing. After an approved submission, refresh the list yourself so the review actually appears.
20
+ - **`submitReview({ product_id, review?, rating?, reviewer?, email? })`** → `{ review_id, status, verified }`. **Text or stars — at least one**: `review` is the body text, `rating` is **1–5 stars** (0 counts as unrated); stars-only and text-only are both valid, only both missing rejects. `reviewer` is the display name. ⚑ **One set of names, both directions** — the payload above, rows back as `{ id, reviewer, review, rating, verified, created_date }`. Not the entity's columns: a near-miss (`content`, `reviewer_name`, `reviewer_email`, ) throws client-side rather than being aliased, since the same wrong names would render the list blank too. It **rejects** with `email_required` | `review_incomplete` (neither text nor stars) | `invalid_rating` | `not_found` — catch it, read `storefrontErrorCode(e)`, and land each code on its own field, so a failed submit says what to fix instead of resolving into nothing. After an approved submission, refresh the list yourself so the review actually appears.
21
21
 
22
22
  ## What ships
23
23
 
@@ -25,13 +25,10 @@
25
25
  */
26
26
 
27
27
  /**
28
- * Review payload keys a form reaches for instead of the API's, and what each
29
- * one should be. These are **rejected by name, never aliased**: a review is
30
- * submitted with these keys and rendered back with the API's, so a store that
31
- * posts `content` also reads `reviewer_name` off the response and shows every
32
- * author as "Anonymous". Accepting the alias would fix the submit and leave the
33
- * list broken — with nothing failing anywhere to say so. One set of names,
34
- * enforced at the first call that gets them wrong.
28
+ * Near-miss payload keys, rejected rather than aliased: the same names come
29
+ * back on the review rows, so a store that posts `content` reads
30
+ * `reviewer_name` too aliasing the submit would leave every author blank
31
+ * with nothing failing to say why.
35
32
  */
36
33
  const REVIEW_FIELD_FIXES = {
37
34
  content: "review",
@@ -44,10 +41,7 @@ const REVIEW_FIELD_FIXES = {
44
41
  reviewer_email: "email",
45
42
  };
46
43
 
47
- const REVIEW_SHAPES =
48
- "The payload is { product_id, review, rating, reviewer, email }, and reviews come " +
49
- "back as { id, reviewer, review, rating, verified, created_date } — the same names " +
50
- "on both sides, and not the ProductReview entity's columns.";
44
+ const REVIEW_SIGNATURE = "submitReview({ product_id, review, rating, reviewer, email })";
51
45
 
52
46
  /** Throw when a payload uses a near-miss name and leaves the real field empty. */
53
47
  function assertReviewFieldNames(payload) {
@@ -55,9 +49,7 @@ function assertReviewFieldNames(payload) {
55
49
  const canonical = REVIEW_FIELD_FIXES[k];
56
50
  return canonical && !String(payload[canonical] ?? "").trim();
57
51
  });
58
- if (!wrong.length) return;
59
- const fixes = wrong.map((k) => `\`${k}\` should be \`${REVIEW_FIELD_FIXES[k]}\``).join(", ");
60
- throw new Error(`submitReview: ${fixes}. ${REVIEW_SHAPES}`);
52
+ if (wrong.length) throw new Error(`${REVIEW_SIGNATURE} — got: ${wrong.join(", ")}`);
61
53
  }
62
54
 
63
55
  /** The stable error code a failed storefront call carries, if any. */
@@ -153,15 +145,10 @@ export function createStorefront(base44, { storageKey = "cart_token", storage }
153
145
  * the keys it did receive, instead of letting the server answer about a
154
146
  * field the customer filled in.
155
147
  *
156
- * **One set of names, both directions.** The payload is `{ product_id,
157
- * review, rating, reviewer, email }` and a review comes back as `{ id,
158
- * reviewer, review, rating, verified, created_date }` not the
159
- * ProductReview entity's columns. A near-miss (`content`, `text`, `body`,
160
- * `comment`; `reviewer_name`, `name`, `author`; `reviewer_email`) throws
161
- * naming the field it should be, and is deliberately **not** aliased: a
162
- * store that posts `content` reads `reviewer_name` back too, so accepting
163
- * the alias would fix the submit and leave every author rendering blank,
164
- * with nothing failing to say why.
148
+ * **One set of names, both directions** `{ product_id, review, rating,
149
+ * reviewer, email }` in, `{ id, reviewer, review, rating, verified,
150
+ * created_date }` back. Not the entity's columns: a near-miss (`content`,
151
+ * `reviewer_name`, `reviewer_email`, …) throws rather than being aliased.
165
152
  *
166
153
  * Resolves to `{ review_id, status, verified }` — **`status` is
167
154
  * `"approved"` or `"hold"` depending on the store's `auto_approve_reviews`
@@ -178,11 +165,7 @@ export function createStorefront(base44, { storageKey = "cart_token", storage }
178
165
  assertReviewFieldNames(payload);
179
166
  const rated = rating != null && Number(rating) >= 1;
180
167
  if (!String(review ?? "").trim() && !rated) {
181
- throw new Error(
182
- `submitReview needs \`review\` text or a \`rating\` of 1-5. Received: ${
183
- Object.keys(payload).join(", ") || "nothing"
184
- }. ${REVIEW_SHAPES}`,
185
- );
168
+ throw new Error(`${REVIEW_SIGNATURE} — needs review text or a rating of 1-5`);
186
169
  }
187
170
  return inv("commerce/storefront-catalog", {
188
171
  action: "submit-review",