brainerce 1.10.3 → 1.11.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/README.md CHANGED
@@ -4,7 +4,7 @@ Official SDK for building e-commerce storefronts with **Brainerce Platform**.
4
4
 
5
5
  This SDK provides a complete solution for vibe-coded sites, AI-built stores (Cursor, Lovable, v0), and custom storefronts to connect to Brainerce's unified commerce API.
6
6
 
7
- > **🤖 AI Agents / Vibe Coders:** See [AI_BUILDER_PROMPT.md](./AI_BUILDER_PROMPT.md) for a concise, copy-paste-ready prompt optimized for AI code generation. It contains the essential rules and complete code examples to build a working store.
7
+ > **AI Agents / Vibe Coders:** Use the MCP server for AI-powered store building: `npx @brainerce/mcp-server`. It provides docs, code templates, and live store capabilities to any AI tool (Cursor, Lovable, Claude Code).
8
8
 
9
9
  ## Installation
10
10
 
@@ -1058,7 +1058,7 @@ interface Product {
1058
1058
  sku: string;
1059
1059
  basePrice: number;
1060
1060
  salePrice?: number | null;
1061
- status: 'active' | 'draft' | 'archived';
1061
+ status: 'active' | 'draft';
1062
1062
  type: 'SIMPLE' | 'VARIABLE';
1063
1063
  images?: ProductImage[];
1064
1064
  inventory?: InventoryInfo | null;
package/dist/index.d.mts CHANGED
@@ -73,6 +73,22 @@ interface BrainerceClientOptions {
73
73
  statusCode: number;
74
74
  path?: string;
75
75
  }) => void;
76
+ /**
77
+ * Origin header to send with requests.
78
+ * Browsers add this automatically, but Node.js environments (SSR, scripts, npx)
79
+ * do not. When running server-side, the SDK will auto-derive it from `baseUrl`
80
+ * if not explicitly provided.
81
+ *
82
+ * @example
83
+ * ```typescript
84
+ * // Explicit origin for server-side usage
85
+ * const client = new BrainerceClient({
86
+ * connectionId: 'vc_abc123...',
87
+ * origin: 'https://mysite.com',
88
+ * });
89
+ * ```
90
+ */
91
+ origin?: string;
76
92
  /**
77
93
  * Enable proxy mode for BFF (Backend-for-Frontend) pattern.
78
94
  * When true, the SDK skips client-side customer token checks and does not
@@ -167,7 +183,7 @@ interface Product {
167
183
  salePrice?: string | null;
168
184
  /** Cost price as string. Use parseFloat() for calculations. */
169
185
  costPrice?: string | null;
170
- /** Product status (active, draft, archived). Always returned by backend. */
186
+ /** Product status (active, draft). Always returned by backend. */
171
187
  status: string;
172
188
  type: 'SIMPLE' | 'VARIABLE';
173
189
  /** Whether product is downloadable/digital. */
@@ -642,7 +658,7 @@ interface ProductQueryParams {
642
658
  page?: number;
643
659
  limit?: number;
644
660
  search?: string;
645
- status?: 'active' | 'draft' | 'archived';
661
+ status?: 'active' | 'draft';
646
662
  /** Filter by category IDs (comma-separated or array) */
647
663
  categories?: string | string[];
648
664
  /** Filter by brand IDs (comma-separated or array) */
@@ -750,7 +766,7 @@ interface UpdateProductDto {
750
766
  basePrice?: number;
751
767
  salePrice?: number | null;
752
768
  costPrice?: number | null;
753
- status?: 'active' | 'draft' | 'archived';
769
+ status?: 'active' | 'draft';
754
770
  isDownloadable?: boolean;
755
771
  categories?: string[];
756
772
  tags?: string[];
@@ -3541,6 +3557,7 @@ declare class BrainerceClient {
3541
3557
  * This is needed because Stripe redirects lose in-memory state.
3542
3558
  */
3543
3559
  private readonly ACTIVE_CHECKOUT_KEY;
3560
+ private readonly origin?;
3544
3561
  private readonly proxyMode;
3545
3562
  private readonly onAuthError?;
3546
3563
  constructor(options: BrainerceClientOptions);
package/dist/index.d.ts CHANGED
@@ -73,6 +73,22 @@ interface BrainerceClientOptions {
73
73
  statusCode: number;
74
74
  path?: string;
75
75
  }) => void;
76
+ /**
77
+ * Origin header to send with requests.
78
+ * Browsers add this automatically, but Node.js environments (SSR, scripts, npx)
79
+ * do not. When running server-side, the SDK will auto-derive it from `baseUrl`
80
+ * if not explicitly provided.
81
+ *
82
+ * @example
83
+ * ```typescript
84
+ * // Explicit origin for server-side usage
85
+ * const client = new BrainerceClient({
86
+ * connectionId: 'vc_abc123...',
87
+ * origin: 'https://mysite.com',
88
+ * });
89
+ * ```
90
+ */
91
+ origin?: string;
76
92
  /**
77
93
  * Enable proxy mode for BFF (Backend-for-Frontend) pattern.
78
94
  * When true, the SDK skips client-side customer token checks and does not
@@ -167,7 +183,7 @@ interface Product {
167
183
  salePrice?: string | null;
168
184
  /** Cost price as string. Use parseFloat() for calculations. */
169
185
  costPrice?: string | null;
170
- /** Product status (active, draft, archived). Always returned by backend. */
186
+ /** Product status (active, draft). Always returned by backend. */
171
187
  status: string;
172
188
  type: 'SIMPLE' | 'VARIABLE';
173
189
  /** Whether product is downloadable/digital. */
@@ -642,7 +658,7 @@ interface ProductQueryParams {
642
658
  page?: number;
643
659
  limit?: number;
644
660
  search?: string;
645
- status?: 'active' | 'draft' | 'archived';
661
+ status?: 'active' | 'draft';
646
662
  /** Filter by category IDs (comma-separated or array) */
647
663
  categories?: string | string[];
648
664
  /** Filter by brand IDs (comma-separated or array) */
@@ -750,7 +766,7 @@ interface UpdateProductDto {
750
766
  basePrice?: number;
751
767
  salePrice?: number | null;
752
768
  costPrice?: number | null;
753
- status?: 'active' | 'draft' | 'archived';
769
+ status?: 'active' | 'draft';
754
770
  isDownloadable?: boolean;
755
771
  categories?: string[];
756
772
  tags?: string[];
@@ -3541,6 +3557,7 @@ declare class BrainerceClient {
3541
3557
  * This is needed because Stripe redirects lose in-memory state.
3542
3558
  */
3543
3559
  private readonly ACTIVE_CHECKOUT_KEY;
3560
+ private readonly origin?;
3544
3561
  private readonly proxyMode;
3545
3562
  private readonly onAuthError?;
3546
3563
  constructor(options: BrainerceClientOptions);
package/dist/index.js CHANGED
@@ -223,6 +223,15 @@ var BrainerceClient = class {
223
223
  }
224
224
  this.baseUrl = resolvedBase;
225
225
  this.timeout = options.timeout || DEFAULT_TIMEOUT;
226
+ if (options.origin) {
227
+ this.origin = options.origin;
228
+ } else if (typeof window === "undefined") {
229
+ try {
230
+ const parsed = new URL(resolvedBase);
231
+ this.origin = parsed.origin;
232
+ } catch {
233
+ }
234
+ }
226
235
  this.proxyMode = options.proxyMode || false;
227
236
  this.onAuthError = options.onAuthError;
228
237
  this.hydrateSessionCart();
@@ -327,14 +336,18 @@ var BrainerceClient = class {
327
336
  const controller = new AbortController();
328
337
  const timeoutId = setTimeout(() => controller.abort(), this.timeout);
329
338
  try {
339
+ const headers = {
340
+ Authorization: `Bearer ${this.apiKey}`,
341
+ "Content-Type": "application/json",
342
+ "X-SDK-Version": "1.11.0",
343
+ "ngrok-skip-browser-warning": "true"
344
+ };
345
+ if (this.origin) {
346
+ headers["Origin"] = this.origin;
347
+ }
330
348
  const response = await fetch(url.toString(), {
331
349
  method,
332
- headers: {
333
- Authorization: `Bearer ${this.apiKey}`,
334
- "Content-Type": "application/json",
335
- "X-SDK-Version": "0.3.0",
336
- "ngrok-skip-browser-warning": "true"
337
- },
350
+ headers,
338
351
  body: body ? JSON.stringify(body) : void 0,
339
352
  signal: controller.signal
340
353
  });
@@ -384,9 +397,12 @@ var BrainerceClient = class {
384
397
  try {
385
398
  const headers = {
386
399
  "Content-Type": "application/json",
387
- "X-SDK-Version": "0.3.0",
400
+ "X-SDK-Version": "1.11.0",
388
401
  "ngrok-skip-browser-warning": "true"
389
402
  };
403
+ if (this.origin) {
404
+ headers["Origin"] = this.origin;
405
+ }
390
406
  if (this.proxyMode && method !== "GET") {
391
407
  headers["X-Requested-With"] = "brainerce";
392
408
  }
@@ -452,9 +468,12 @@ var BrainerceClient = class {
452
468
  try {
453
469
  const headers = {
454
470
  "Content-Type": "application/json",
455
- "X-SDK-Version": "0.3.0",
471
+ "X-SDK-Version": "1.11.0",
456
472
  "ngrok-skip-browser-warning": "true"
457
473
  };
474
+ if (this.origin) {
475
+ headers["Origin"] = this.origin;
476
+ }
458
477
  if (this.customerToken) {
459
478
  headers["Authorization"] = `Bearer ${this.customerToken}`;
460
479
  }
package/dist/index.mjs CHANGED
@@ -165,6 +165,15 @@ var BrainerceClient = class {
165
165
  }
166
166
  this.baseUrl = resolvedBase;
167
167
  this.timeout = options.timeout || DEFAULT_TIMEOUT;
168
+ if (options.origin) {
169
+ this.origin = options.origin;
170
+ } else if (typeof window === "undefined") {
171
+ try {
172
+ const parsed = new URL(resolvedBase);
173
+ this.origin = parsed.origin;
174
+ } catch {
175
+ }
176
+ }
168
177
  this.proxyMode = options.proxyMode || false;
169
178
  this.onAuthError = options.onAuthError;
170
179
  this.hydrateSessionCart();
@@ -269,14 +278,18 @@ var BrainerceClient = class {
269
278
  const controller = new AbortController();
270
279
  const timeoutId = setTimeout(() => controller.abort(), this.timeout);
271
280
  try {
281
+ const headers = {
282
+ Authorization: `Bearer ${this.apiKey}`,
283
+ "Content-Type": "application/json",
284
+ "X-SDK-Version": "1.11.0",
285
+ "ngrok-skip-browser-warning": "true"
286
+ };
287
+ if (this.origin) {
288
+ headers["Origin"] = this.origin;
289
+ }
272
290
  const response = await fetch(url.toString(), {
273
291
  method,
274
- headers: {
275
- Authorization: `Bearer ${this.apiKey}`,
276
- "Content-Type": "application/json",
277
- "X-SDK-Version": "0.3.0",
278
- "ngrok-skip-browser-warning": "true"
279
- },
292
+ headers,
280
293
  body: body ? JSON.stringify(body) : void 0,
281
294
  signal: controller.signal
282
295
  });
@@ -326,9 +339,12 @@ var BrainerceClient = class {
326
339
  try {
327
340
  const headers = {
328
341
  "Content-Type": "application/json",
329
- "X-SDK-Version": "0.3.0",
342
+ "X-SDK-Version": "1.11.0",
330
343
  "ngrok-skip-browser-warning": "true"
331
344
  };
345
+ if (this.origin) {
346
+ headers["Origin"] = this.origin;
347
+ }
332
348
  if (this.proxyMode && method !== "GET") {
333
349
  headers["X-Requested-With"] = "brainerce";
334
350
  }
@@ -394,9 +410,12 @@ var BrainerceClient = class {
394
410
  try {
395
411
  const headers = {
396
412
  "Content-Type": "application/json",
397
- "X-SDK-Version": "0.3.0",
413
+ "X-SDK-Version": "1.11.0",
398
414
  "ngrok-skip-browser-warning": "true"
399
415
  };
416
+ if (this.origin) {
417
+ headers["Origin"] = this.origin;
418
+ }
400
419
  if (this.customerToken) {
401
420
  headers["Authorization"] = `Bearer ${this.customerToken}`;
402
421
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "brainerce",
3
- "version": "1.10.3",
3
+ "version": "1.11.0",
4
4
  "description": "Official SDK for building e-commerce storefronts with Brainerce Platform. Perfect for vibe-coded sites, AI-built stores (Cursor, Lovable, v0), and custom storefronts.",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -14,8 +14,7 @@
14
14
  },
15
15
  "files": [
16
16
  "dist",
17
- "README.md",
18
- "AI_BUILDER_PROMPT.md"
17
+ "README.md"
19
18
  ],
20
19
  "scripts": {
21
20
  "build": "tsup src/index.ts --format cjs,esm --dts",
@@ -1,843 +0,0 @@
1
- # Brainerce Store Builder
2
-
3
- Build a **{store_type}** store called "{store_name}" | Style: **{style}** | Currency: **{currency}**
4
-
5
- ---
6
-
7
- ## ⛔ STOP! Read These 3 Rules First (Breaking = Store Won't Work)
8
-
9
- ### Rule 1: Guest vs Logged-In = Different Checkout Methods!
10
-
11
- ```typescript
12
- // ❌ THIS WILL FAIL - "Cart not found" error!
13
- const cart = await client.smartGetCart(); // Guest cart has id: "__local__"
14
- await client.createCheckout({ cartId: cart.id }); // 💥 "__local__" doesn't exist on server!
15
-
16
- // ✅ CORRECT - Check user type first!
17
- if (client.isCustomerLoggedIn()) {
18
- // Logged-in user → server cart exists
19
- const checkout = await client.createCheckout({ cartId: cart.id });
20
- const checkoutId = checkout.id;
21
- } else {
22
- // Guest user → use startGuestCheckout()
23
- const result = await client.startGuestCheckout();
24
- const checkoutId = result.checkoutId;
25
- }
26
- ```
27
-
28
- | User Type | Cart Location | Checkout Method | Get Checkout ID |
29
- | ------------- | ------------- | ---------------------------- | ------------------- |
30
- | **Guest** | localStorage | `startGuestCheckout()` | `result.checkoutId` |
31
- | **Logged-in** | Server | `createCheckout({ cartId })` | `checkout.id` |
32
-
33
- ### Rule 2: Complete Checkout & Clear Cart After Payment!
34
-
35
- ```typescript
36
- // On /checkout/success page - MUST DO THIS!
37
- export default function CheckoutSuccessPage() {
38
- const checkoutId = new URLSearchParams(window.location.search).get('checkout_id');
39
-
40
- useEffect(() => {
41
- if (checkoutId) {
42
- // ⚠️ CRITICAL: This sends the order to the server AND clears the cart!
43
- // handlePaymentSuccess() only clears the local cart - it does NOT create the order!
44
- client.completeGuestCheckout(checkoutId);
45
- }
46
- }, []);
47
-
48
- return <div>Thank you for your order!</div>;
49
- }
50
- ```
51
-
52
- > **WARNING:** Do NOT use `handlePaymentSuccess()` to complete an order. It only clears
53
- > the local cart (localStorage) and does NOT communicate with the server.
54
- > Always use `completeGuestCheckout()` after payment succeeds.
55
-
56
- ### Rule 3: Never Hardcode Products!
57
-
58
- ```typescript
59
- // ❌ FORBIDDEN - Store will show fake data!
60
- const products = [{ id: '1', name: 'T-Shirt', price: 29.99 }];
61
-
62
- // ✅ CORRECT - Fetch from API
63
- const { data: products } = await client.getProducts();
64
- ```
65
-
66
- ---
67
-
68
- ## Quick Setup
69
-
70
- ```bash
71
- npm install brainerce
72
- ```
73
-
74
- ```typescript
75
- // lib/brainerce.ts
76
- import { BrainerceClient } from 'brainerce';
77
-
78
- export const client = new BrainerceClient({
79
- connectionId: '{connection_id}',
80
- baseUrl: '{api_url}',
81
- });
82
-
83
- // Restore customer session on page load
84
- export function initBrainerce() {
85
- if (typeof window === 'undefined') return;
86
- const token = localStorage.getItem('customerToken');
87
- if (token) client.setCustomerToken(token);
88
- }
89
-
90
- // Save/clear customer token
91
- export function setCustomerToken(token: string | null) {
92
- if (token) {
93
- localStorage.setItem('customerToken', token);
94
- client.setCustomerToken(token);
95
- } else {
96
- localStorage.removeItem('customerToken');
97
- client.clearCustomerToken();
98
- }
99
- }
100
- ```
101
-
102
- ---
103
-
104
- ## Cart (Works for Both Guest & Logged-in)
105
-
106
- ```typescript
107
- // Get or create cart - handles both guest (localStorage) and logged-in (server) automatically
108
- const cart = await client.smartGetCart();
109
-
110
- // Add to cart - ALWAYS pass name, price, image for guest cart display!
111
- await client.smartAddToCart({
112
- productId: product.id,
113
- variantId: selectedVariant?.id,
114
- quantity: 1,
115
- // IMPORTANT: Pass product info for guest cart display
116
- name: selectedVariant?.name ? `${product.name} - ${selectedVariant.name}` : product.name,
117
- price: getVariantPrice(selectedVariant, product.basePrice),
118
- image: selectedVariant?.image
119
- ? typeof selectedVariant.image === 'string'
120
- ? selectedVariant.image
121
- : selectedVariant.image.url
122
- : product.images?.[0]?.url,
123
- });
124
-
125
- // Update quantity (by productId, not itemId!)
126
- await client.smartUpdateCartItem('prod_xxx', 2); // productId, quantity
127
- await client.smartUpdateCartItem('prod_xxx', 3, 'var_xxx'); // with variant
128
-
129
- // Remove item (by productId, not itemId!)
130
- await client.smartRemoveFromCart('prod_xxx');
131
- await client.smartRemoveFromCart('prod_xxx', 'var_xxx'); // with variant
132
-
133
- // Get cart totals (cart doesn't have .total field!)
134
- import { getCartTotals } from 'brainerce';
135
- const totals = getCartTotals(cart);
136
- // { subtotal: 59.98, discount: 10, shipping: 0, total: 49.98 }
137
-
138
- // All smart* methods return a server Cart (even for guests via session carts)
139
- // Cart has: id, itemCount, subtotal, discountAmount, items, couponCode
140
- ```
141
-
142
- ### 🏷️ Coupon Code (Add to Cart Page!)
143
-
144
- ```typescript
145
- // Apply coupon to cart
146
- const cart = await client.smartGetCart();
147
- const updatedCart = await client.applyCoupon(cart.id, 'SAVE20');
148
- console.log(updatedCart.discountAmount); // "10.00" (string)
149
- console.log(updatedCart.couponCode); // "SAVE20"
150
-
151
- // Remove coupon
152
- const updatedCart = await client.removeCoupon(cartId);
153
-
154
- // Calculate totals including discount
155
- import { getCartTotals } from 'brainerce';
156
- const totals = getCartTotals(cart); // { subtotal, discount, shipping, total }
157
- ```
158
-
159
- **Cart page coupon UI:**
160
-
161
- ```typescript
162
- // State
163
- const [couponCode, setCouponCode] = useState('');
164
- const [couponError, setCouponError] = useState('');
165
- const [isApplying, setIsApplying] = useState(false);
166
-
167
- // Apply handler
168
- async function handleApplyCoupon() {
169
- if (!couponCode.trim() || !('id' in cart)) return;
170
- setIsApplying(true);
171
- setCouponError('');
172
- try {
173
- const updatedCart = await client.applyCoupon(cart.id, couponCode.trim());
174
- setCart(updatedCart);
175
- setCouponCode('');
176
- } catch (err: any) {
177
- setCouponError(err.message || 'Invalid coupon code');
178
- } finally {
179
- setIsApplying(false);
180
- }
181
- }
182
-
183
- // Remove handler
184
- async function handleRemoveCoupon() {
185
- if (!('id' in cart)) return;
186
- const updatedCart = await client.removeCoupon(cart.id);
187
- setCart(updatedCart);
188
- }
189
-
190
- // UI - place in cart order summary
191
- {('id' in cart) && (
192
- <div>
193
- {cart.couponCode ? (
194
- <div className="flex items-center justify-between bg-green-50 p-2 rounded">
195
- <span className="text-green-700 text-sm">🏷️ {cart.couponCode}</span>
196
- <button onClick={handleRemoveCoupon} className="text-red-500 text-sm">✕</button>
197
- </div>
198
- ) : (
199
- <div className="flex gap-2">
200
- <input value={couponCode} onChange={(e) => setCouponCode(e.target.value)}
201
- placeholder="Coupon code" className="flex-1 border rounded px-3 py-2 text-sm" />
202
- <button onClick={handleApplyCoupon} disabled={isApplying}
203
- className="px-4 py-2 bg-gray-800 text-white rounded text-sm">
204
- {isApplying ? '...' : 'Apply'}
205
- </button>
206
- </div>
207
- )}
208
- {couponError && <p className="text-red-500 text-xs mt-1">{couponError}</p>}
209
- </div>
210
- )}
211
-
212
- // Order summary - show discount line
213
- {('id' in cart) && parseFloat(cart.discountAmount) > 0 && (
214
- <div className="text-green-600">Discount: -{formatPrice(cart.discountAmount)}</div>
215
- )}
216
- ```
217
-
218
- **Checkout order summary - coupon carries over from cart:**
219
-
220
- ```typescript
221
- // Checkout already includes coupon from cart
222
- <div>Subtotal: {formatPrice(checkout.subtotal)}</div>
223
- {parseFloat(checkout.discountAmount) > 0 && (
224
- <div className="text-green-600">
225
- Discount ({checkout.couponCode}): -{formatPrice(checkout.discountAmount)}
226
- </div>
227
- )}
228
- <div>Shipping: {formatPrice(selectedRate?.price || '0')}</div>
229
- <div className="font-bold">Total: {formatPrice(checkout.total)}</div>
230
- ```
231
-
232
- ---
233
-
234
- ## 🛒 Partial Checkout (AliExpress Style) - REQUIRED!
235
-
236
- Cart page MUST have checkboxes so users can select which items to buy:
237
-
238
- ```typescript
239
- // Cart page - track selected items
240
- const [selectedIndices, setSelectedIndices] = useState<number[]>(
241
- cart.items.map((_, i) => i) // All selected by default
242
- );
243
-
244
- const toggleItem = (index: number) => {
245
- setSelectedIndices(prev =>
246
- prev.includes(index)
247
- ? prev.filter(i => i !== index)
248
- : [...prev, index]
249
- );
250
- };
251
-
252
- const toggleAll = () => {
253
- if (selectedIndices.length === cart.items.length) {
254
- setSelectedIndices([]); // Deselect all
255
- } else {
256
- setSelectedIndices(cart.items.map((_, i) => i)); // Select all
257
- }
258
- };
259
-
260
- // In your cart UI:
261
- <div>
262
- <label>
263
- <input
264
- type="checkbox"
265
- checked={selectedIndices.length === cart.items.length}
266
- onChange={toggleAll}
267
- />
268
- Select All
269
- </label>
270
- </div>
271
-
272
- {cart.items.map((item, index) => (
273
- <div key={index}>
274
- <input
275
- type="checkbox"
276
- checked={selectedIndices.includes(index)}
277
- onChange={() => toggleItem(index)}
278
- />
279
- {/* ... item details ... */}
280
- </div>
281
- ))}
282
-
283
- // On checkout button - pass selected items!
284
- const handleCheckout = async () => {
285
- if (selectedIndices.length === 0) {
286
- alert('Please select items to checkout');
287
- return;
288
- }
289
-
290
- const result = await client.startGuestCheckout({ selectedIndices });
291
- // Only selected items go to checkout, others stay in cart!
292
- };
293
- ```
294
-
295
- **Why this matters:**
296
-
297
- - Users can buy some items now, leave others for later
298
- - After payment, `completeGuestCheckout()` sends the order and only removes purchased items
299
- - Remaining items stay in cart for future purchase
300
-
301
- **⚠️ Order Summary on Checkout Page - Use checkout.lineItems!**
302
-
303
- ```typescript
304
- // ❌ WRONG - Shows ALL cart items (even unselected ones!)
305
- <div className="order-summary">
306
- {cart.items.map(item => (
307
- <div>{item.product.name} - ${item.price}</div>
308
- ))}
309
- </div>
310
-
311
- // ✅ CORRECT - Shows only items being purchased in this checkout
312
- <div className="order-summary">
313
- {checkout.lineItems.map(item => (
314
- <div>{item.product.name} - ${item.price}</div>
315
- ))}
316
- </div>
317
- ```
318
-
319
- The `checkout` object's `lineItems` array contains ONLY the items selected for this checkout!
320
-
321
- ---
322
-
323
- ## Shipping Destinations (Country/Region Dropdowns)
324
-
325
- Before showing a checkout form, fetch where the store ships to and render `<select>` dropdowns instead of free-text inputs:
326
-
327
- ```typescript
328
- import type { ShippingDestinations } from 'brainerce';
329
-
330
- // Fetch on page load (no checkout needed)
331
- const destinations: ShippingDestinations = await client.getShippingDestinations();
332
- // {
333
- // worldwide: boolean, // true if store ships everywhere
334
- // countries: [{ code: 'US', name: 'United States' }, ...],
335
- // regions: { 'US': [{ code: 'CA', name: 'California' }, ...] }
336
- // }
337
-
338
- // Country <select>
339
- <select value={country} onChange={(e) => setCountry(e.target.value)}>
340
- <option value="">Select country</option>
341
- {destinations.countries.map((c) => (
342
- <option key={c.code} value={c.code}>{c.name}</option>
343
- ))}
344
- </select>
345
-
346
- // Region <select> — only show when regions exist for selected country
347
- {destinations.regions[country]?.length > 0 ? (
348
- <select value={region} onChange={(e) => setRegion(e.target.value)}>
349
- <option value="">Select region</option>
350
- {destinations.regions[country].map((r) => (
351
- <option key={r.code} value={r.code}>{r.name}</option>
352
- ))}
353
- </select>
354
- ) : (
355
- <input type="text" value={region} onChange={(e) => setRegion(e.target.value)} />
356
- )}
357
- ```
358
-
359
- > **Note:** `regions` is an object keyed by country code. If a country has no region restrictions, it won't appear in `regions` — use a free-text input as fallback.
360
-
361
- ---
362
-
363
- ## Complete Checkout Flow
364
-
365
- ### Step 1: Start Checkout (Different for Guest vs Logged-in!)
366
-
367
- ```typescript
368
- async function startCheckout() {
369
- const cart = await client.smartGetCart();
370
-
371
- if (cart.items.length === 0) {
372
- alert('Cart is empty');
373
- return;
374
- }
375
-
376
- let checkoutId: string;
377
-
378
- if (client.isCustomerLoggedIn()) {
379
- // Logged-in: create checkout from server cart
380
- const checkout = await client.createCheckout({ cartId: cart.id });
381
- checkoutId = checkout.id;
382
- } else {
383
- // Guest: use startGuestCheckout (syncs local cart to server)
384
- const result = await client.startGuestCheckout();
385
- if (!result.tracked || !result.checkoutId) {
386
- throw new Error('Failed to create checkout');
387
- }
388
- checkoutId = result.checkoutId;
389
- }
390
-
391
- // Save for payment page
392
- localStorage.setItem('checkoutId', checkoutId);
393
-
394
- // Navigate to checkout
395
- window.location.href = '/checkout';
396
- }
397
- ```
398
-
399
- ### Step 2: Shipping Address
400
-
401
- ```typescript
402
- const checkoutId = localStorage.getItem('checkoutId')!;
403
-
404
- // Set shipping address (email is required!)
405
- const { checkout, rates } = await client.setShippingAddress(checkoutId, {
406
- email: 'customer@example.com',
407
- firstName: 'John',
408
- lastName: 'Doe',
409
- line1: '123 Main St',
410
- city: 'New York',
411
- region: 'NY', // ⚠️ Use 'region', NOT 'state'!
412
- postalCode: '10001',
413
- country: 'US',
414
- });
415
-
416
- // Show available shipping rates
417
- rates.forEach((rate) => {
418
- console.log(`${rate.name}: $${rate.price}`);
419
- });
420
- ```
421
-
422
- ### Step 3: Select Shipping Method
423
-
424
- ```typescript
425
- await client.selectShippingMethod(checkoutId, selectedRateId);
426
- ```
427
-
428
- ### Step 4: Payment (Multi-Provider)
429
-
430
- ```typescript
431
- // 1. Check if payment is configured
432
- const { hasPayments, providers } = await client.getPaymentProviders();
433
- if (!hasPayments) {
434
- return <div>Payment not configured for this store</div>;
435
- }
436
-
437
- // 2. Create payment intent — returns provider type!
438
- const intent = await client.createPaymentIntent(checkoutId, {
439
- successUrl: `${window.location.origin}/checkout/success?checkout_id=${checkoutId}`,
440
- cancelUrl: `${window.location.origin}/checkout?error=cancelled`,
441
- });
442
-
443
- // 3. Branch by provider
444
- if (intent.provider === 'grow') {
445
- // Grow: clientSecret is a payment URL — show in iframe
446
- // <iframe src={intent.clientSecret} style={{ width: '100%', minHeight: '600px', border: 'none' }} allow="payment" />
447
- // Supports credit cards, Bit, Apple Pay, Google Pay, bank transfers
448
- // Add fallback: <a href={intent.clientSecret} target="_blank">Open payment in new tab</a>
449
- // Order created automatically via webhook!
450
- } else {
451
- // Stripe: install @stripe/stripe-js @stripe/react-stripe-js
452
- import { loadStripe } from '@stripe/stripe-js';
453
- const stripeProvider = providers.find(p => p.provider === 'stripe');
454
- const stripe = await loadStripe(stripeProvider.publicKey, {
455
- stripeAccount: stripeProvider.stripeAccountId,
456
- });
457
-
458
- // Confirm payment (in your payment form)
459
- const { error } = await stripe.confirmPayment({
460
- elements,
461
- confirmParams: {
462
- return_url: `${window.location.origin}/checkout/success?checkout_id=${checkoutId}`,
463
- },
464
- });
465
-
466
- if (error) {
467
- setError(error.message);
468
- }
469
- // If no error, Stripe redirects to success page
470
- }
471
- ```
472
-
473
- ### Step 5: Success Page (Complete Order & Clear Cart!)
474
-
475
- ```typescript
476
- // /checkout/success/page.tsx
477
- 'use client';
478
- import { useEffect, useState } from 'react';
479
- import { client } from '@/lib/brainerce';
480
-
481
- export default function CheckoutSuccessPage() {
482
- const [orderNumber, setOrderNumber] = useState<string>();
483
- const [loading, setLoading] = useState(true);
484
-
485
- useEffect(() => {
486
- // Break out of iframe if redirected here from Grow payment page
487
- if (window.top !== window.self) {
488
- window.top!.location.href = window.location.href;
489
- return;
490
- }
491
-
492
- const checkoutId = new URLSearchParams(window.location.search).get('checkout_id');
493
-
494
- if (checkoutId) {
495
- // ⚠️ CRITICAL: Complete the order on the server AND clear the cart!
496
- // Do NOT use handlePaymentSuccess() - it only clears localStorage!
497
- client.completeGuestCheckout(checkoutId).then(result => {
498
- setOrderNumber(result.orderNumber);
499
- setLoading(false);
500
- }).catch(() => {
501
- // Order may already be completed (e.g., page refresh) - check status
502
- client.getPaymentStatus(checkoutId).then(status => {
503
- if (status.orderNumber) {
504
- setOrderNumber(status.orderNumber);
505
- }
506
- setLoading(false);
507
- });
508
- });
509
- }
510
- }, []);
511
-
512
- return (
513
- <div className="text-center py-12">
514
- <h1 className="text-2xl font-bold text-green-600">Thank you for your order!</h1>
515
- {loading && <p className="mt-2">Processing your order...</p>}
516
- {orderNumber && <p className="mt-2">Order #{orderNumber}</p>}
517
- <p className="mt-4">A confirmation email will be sent shortly.</p>
518
- </div>
519
- );
520
- }
521
- ```
522
-
523
- ---
524
-
525
- ## Partial Checkout (AliExpress Style)
526
-
527
- Allow customers to buy only some items from their cart:
528
-
529
- ```typescript
530
- // Start checkout with only selected items (by index)
531
- const result = await client.startGuestCheckout({
532
- selectedIndices: [0, 2], // Buy items at index 0 and 2 only
533
- });
534
-
535
- // After payment, completeGuestCheckout() sends the order AND removes only those items!
536
- // Other items stay in cart.
537
- ```
538
-
539
- ---
540
-
541
- ## Products API
542
-
543
- ```typescript
544
- // List products with pagination
545
- const { data: products, meta } = await client.getProducts({
546
- page: 1,
547
- limit: 20,
548
- search: 'blue shirt', // Searches name, description, SKU, categories, tags
549
- });
550
- // meta = { page: 1, limit: 20, total: 150, totalPages: 8 }
551
-
552
- // Get single product by slug (for product detail page)
553
- const product = await client.getProductBySlug('blue-cotton-shirt');
554
-
555
- // Search suggestions (for autocomplete)
556
- const suggestions = await client.getSearchSuggestions('blue', 5);
557
- // { products: [...], categories: [...] }
558
- ```
559
-
560
- ---
561
-
562
- ## Product Recommendations (Cross-Sells, Upsells, Related)
563
-
564
- Stores can configure product relations. Use these to boost sales with smart product suggestions:
565
-
566
- | Type | Where to Show | Purpose |
567
- | --------------- | ---------------------- | ---------------------------------------------- |
568
- | **Cross-sells** | Cart page | Complementary products ("You might also need") |
569
- | **Upsells** | Product page | Premium alternatives ("Upgrade your choice") |
570
- | **Related** | Bottom of product page | Similar products |
571
-
572
- ```typescript
573
- import type { ProductRecommendationsResponse, CartRecommendationsResponse } from 'brainerce';
574
-
575
- // Product page — recommendations come EMBEDDED in the product response (no extra API call needed)
576
- const product = await client.getProductBySlug('some-slug');
577
- const recs = (product as any).recommendations as ProductRecommendationsResponse | undefined;
578
- // recs?.upsells — premium alternatives (show on product page)
579
- // recs?.related — similar products (show at bottom of product page)
580
- // recs?.crossSells — complementary products (typically used on cart page)
581
-
582
- // Each recommendation has: id, name, slug, basePrice, salePrice, images[], type, inventory
583
-
584
- // Cart page — cross-sell suggestions for cart items (separate call, since cart has no embedded recs)
585
- const cart = await client.smartGetCart();
586
- const cartRecs: CartRecommendationsResponse = await client.getCartRecommendations(cart.id, 4);
587
- // cartRecs.recommendations — deduplicated cross-sells (excludes items already in cart)
588
-
589
- // Render recommendation cards on product page
590
- {recs?.upsells && recs.upsells.length > 0 && (
591
- <section>
592
- <h2>Upgrade Your Choice</h2>
593
- <div className="grid grid-cols-2 sm:grid-cols-4 gap-4">
594
- {recs.upsells.map(item => (
595
- <a key={item.id} href={`/products/${item.slug}`}>
596
- <img src={item.images?.[0]?.url} alt={item.name} />
597
- <p>{item.name}</p>
598
- <p>{formatPrice(item.salePrice || item.basePrice)}</p>
599
- </a>
600
- ))}
601
- </div>
602
- </section>
603
- )}
604
- ```
605
-
606
- > **Note:** Recommendations return empty arrays when no relations are configured — the UI just renders nothing. Always build the sections. The `getProductRecommendations()` SDK method still works as a fallback for older storefronts.
607
-
608
- ---
609
-
610
- ## Product Custom Fields (Metafields)
611
-
612
- Products may have custom fields defined by the store owner (e.g., "Material", "Care Instructions", "Warranty").
613
-
614
- **Important:** Each metafield has a `type` field. When rendering, you **must** check `field.type` and render accordingly:
615
-
616
- | Type | Rendering |
617
- | ---------------------------------- | ------------------------------------------------------- |
618
- | `IMAGE` | `<img>` thumbnail (value is URL) |
619
- | `GALLERY` | Row of `<img>` thumbnails (value is JSON array of URLs) |
620
- | `URL` | `<a>` clickable link |
621
- | `COLOR` | Color swatch + hex value |
622
- | `BOOLEAN` | "Yes" / "No" |
623
- | `DATE` | `new Date(value).toLocaleDateString()` |
624
- | `DATETIME` | `new Date(value).toLocaleString()` |
625
- | `TEXT`, `TEXTAREA`, `NUMBER`, etc. | Plain text |
626
-
627
- ```typescript
628
- import { getProductMetafield, getProductMetafieldValue } from 'brainerce';
629
- import type { ProductMetafield } from 'brainerce';
630
-
631
- // Access metafields on a product
632
- const product = await client.getProductBySlug('blue-shirt');
633
-
634
- // ⚠️ MUST render based on type! Don't just show field.value as text for all types.
635
- function MetafieldValue({ field }: { field: ProductMetafield }) {
636
- switch (field.type) {
637
- case 'IMAGE':
638
- return field.value ? <img src={field.value} alt={field.definitionName} className="h-16 w-16 rounded object-cover" /> : <>-</>;
639
- case 'GALLERY': {
640
- let urls: string[] = [];
641
- try { urls = JSON.parse(field.value); } catch { urls = field.value ? [field.value] : []; }
642
- return <div className="flex gap-2">{urls.map((url, i) => <img key={i} src={url} className="h-16 w-16 rounded object-cover" />)}</div>;
643
- }
644
- case 'URL':
645
- return field.value ? <a href={field.value} target="_blank" rel="noopener noreferrer">{field.value}</a> : <>-</>;
646
- case 'COLOR':
647
- return <span><span className="inline-block h-4 w-4 rounded-full border" style={{ backgroundColor: field.value }} /> {field.value}</span>;
648
- case 'BOOLEAN':
649
- return <>{field.value === 'true' ? 'Yes' : 'No'}</>;
650
- case 'DATE':
651
- return <>{field.value ? new Date(field.value).toLocaleDateString() : '-'}</>;
652
- case 'DATETIME':
653
- return <>{field.value ? new Date(field.value).toLocaleString() : '-'}</>;
654
- default:
655
- return <>{field.value || '-'}</>;
656
- }
657
- }
658
-
659
- // Display in spec table
660
- {product.metafields?.map(mf => (
661
- <tr key={mf.id}>
662
- <td>{mf.definitionName}</td>
663
- <td><MetafieldValue field={mf} /></td>
664
- </tr>
665
- ))}
666
-
667
- // Get specific field by key
668
- const material = getProductMetafieldValue(product, 'material');
669
- const careInstructions = getProductMetafield(product, 'care_instructions');
670
-
671
- // Get available metafield definitions (schema)
672
- const { definitions } = await client.getPublicMetafieldDefinitions();
673
- // Use definitions to build dynamic UI (filters, forms, etc.)
674
- ```
675
-
676
- > **Tip:** `metafields` may be empty if the store hasn't defined custom fields. Always use optional chaining.
677
-
678
- ---
679
-
680
- ## Customer Authentication
681
-
682
- ```typescript
683
- // Register
684
- const auth = await client.registerCustomer({
685
- email: 'john@example.com',
686
- password: 'securepass123',
687
- firstName: 'John',
688
- lastName: 'Doe',
689
- });
690
-
691
- if (auth.requiresVerification) {
692
- // Store token for verification step
693
- localStorage.setItem('verificationToken', auth.token);
694
- localStorage.setItem('verificationEmail', 'john@example.com');
695
- window.location.href = '/verify-email';
696
- } else {
697
- client.setCustomerToken(auth.token);
698
- localStorage.setItem('customerToken', auth.token);
699
- }
700
-
701
- // Login
702
- const auth = await client.loginCustomer('john@example.com', 'password');
703
-
704
- if (auth.requiresVerification) {
705
- localStorage.setItem('verificationToken', auth.token);
706
- localStorage.setItem('verificationEmail', 'john@example.com');
707
- window.location.href = '/verify-email';
708
- } else {
709
- client.setCustomerToken(auth.token);
710
- localStorage.setItem('customerToken', auth.token);
711
- }
712
-
713
- // Verify email (on /verify-email page)
714
- const result = await client.verifyEmail(code, token);
715
- if (result.verified) {
716
- client.setCustomerToken(token);
717
- localStorage.setItem('customerToken', token);
718
- localStorage.removeItem('verificationToken');
719
- localStorage.removeItem('verificationEmail');
720
- window.location.href = '/account';
721
- }
722
-
723
- // Resend verification code
724
- await client.resendVerificationEmail(token);
725
-
726
- // Forgot password (on /forgot-password page)
727
- await client.forgotPassword(email);
728
- // Always succeeds (prevents email enumeration)
729
-
730
- // Reset password (on /reset-password page — user arrives via email link)
731
- const token = new URLSearchParams(window.location.search).get('token');
732
- await client.resetPassword(token!, newPassword);
733
- // On success: redirect to /login
734
-
735
- // Logout
736
- client.setCustomerToken(null);
737
- localStorage.removeItem('customerToken');
738
-
739
- // Get profile (requires token)
740
- const profile = await client.getMyProfile();
741
-
742
- // Get order history
743
- const { data: orders, meta } = await client.getMyOrders({ page: 1, limit: 10 });
744
- ```
745
-
746
- ---
747
-
748
- ## OAuth / Social Login
749
-
750
- ```typescript
751
- // Get available providers for this store
752
- const { providers } = await client.getAvailableOAuthProviders();
753
- // providers = ['GOOGLE', 'FACEBOOK', 'GITHUB']
754
-
755
- // Redirect to OAuth provider
756
- const { authorizationUrl } = await client.getOAuthAuthorizeUrl('GOOGLE', {
757
- redirectUrl: `${window.location.origin}/auth/callback`,
758
- });
759
- window.location.href = authorizationUrl;
760
-
761
- // Handle callback (on /auth/callback page — backend redirects here with params)
762
- const params = new URLSearchParams(window.location.search);
763
- if (params.get('oauth_success') === 'true') {
764
- const token = params.get('token');
765
- client.setCustomerToken(token!);
766
- // Also available: customer_id, customer_email, is_new
767
- } else if (params.get('oauth_error')) {
768
- // Show error to user
769
- }
770
- ```
771
-
772
- ---
773
-
774
- ## Required Pages Checklist
775
-
776
- - [ ] **Home** (`/`) - Featured products grid
777
- - [ ] **Products** (`/products`) - Product list with infinite scroll
778
- - [ ] **Product Detail** (`/products/[slug]`) - Use `getProductBySlug(slug)`. Show **upsells** + **related products** from `product.recommendations` (embedded in response)
779
- - [ ] **Cart** (`/cart`) - Show items, quantities, totals, **coupon code input**, discount display, **cross-sell recommendations** via `getCartRecommendations()`
780
- - [ ] **Checkout** (`/checkout`) - Address → Shipping → Payment. **Show discount in order summary!**
781
- - [ ] **Success** (`/checkout/success`) - **Must call `completeGuestCheckout()`!**
782
- - [ ] **Login** (`/login`) - Email/password + social buttons, handle `requiresVerification`
783
- - [ ] **Register** (`/register`) - Registration form, handle `requiresVerification`
784
- - [ ] **Verify Email** (`/verify-email`) - 6-digit code input + resend button. **ALWAYS create this page** even if verification is currently disabled — the store owner can enable it at any time
785
- - [ ] **Forgot Password** (`/forgot-password`) - Email input, shows success message
786
- - [ ] **Reset Password** (`/reset-password`) - Token from URL + new password form
787
- - [ ] **OAuth Callback** (`/auth/callback`) - Handle OAuth redirect with token from URL params
788
- - [ ] **Account** (`/account`) - Profile + order history
789
- - [ ] **Header** - Logo, nav, cart icon with count, search
790
-
791
- ### ALWAYS Build These (Even If Currently Disabled)
792
-
793
- Some features may not be configured yet, but the store owner can enable them at any time. **Always create the UI** — SDK methods return empty/null when not configured:
794
-
795
- - **Email Verification** → `/verify-email` page. `requiresVerification` is checked in login/register flows.
796
- - **OAuth Buttons** → Social login buttons on Login & Register + `/auth/callback` page. `getAvailableOAuthProviders()` returns `[]` when none configured — buttons just don't render.
797
- - **Password Reset** → `/forgot-password` + `/reset-password` pages. `forgotPassword()` silently succeeds when no account exists.
798
- - **Discount Banners** → `getDiscountBanners()` returns `[]` when no rules — component renders nothing.
799
- - **Product Discount Badges** → `getProductDiscountBadge(id)` returns `null` — renders nothing.
800
- - **Cart Nudges** → `cart.nudges` is `[]` — renders nothing.
801
- - **Coupon Input** → Always show in cart. Works even with no coupons configured.
802
- - **Product Recommendations** → Upsells + related on product page (from `product.recommendations`), cross-sells on cart page (`getCartRecommendations()`). Returns empty arrays when none configured.
803
-
804
- ---
805
-
806
- ## Common Type Gotchas
807
-
808
- ```typescript
809
- // ❌ WRONG // ✅ CORRECT
810
- address.state address.region
811
- cart.total getCartTotals(cart).total
812
- cart.discount cart.discountAmount
813
- item.name (in cart) item.product.name
814
- response.url (OAuth) response.authorizationUrl
815
- providers.forEach (OAuth) response.providers.forEach
816
- status === 'completed' status === 'succeeded'
817
- product.metafields.name product.metafields[0].definitionName
818
- product.metafields.key product.metafields[0].definitionKey
819
- orderItem.unitPrice orderItem.price (OrderItem is FLAT, not nested!)
820
- cartItem.price cartItem.unitPrice (Cart/Checkout items use unitPrice)
821
- waitResult.orderNumber waitResult.status.orderNumber (nested in PaymentStatus)
822
- variant.attributes.map(...) Object.entries(variant.attributes || {}) (it's an object!)
823
- categorySuggestion.slug // ❌ doesn't exist! Only: id, name, productCount
824
- order.status === 'COMPLETED' order.status === 'delivered' (OrderStatus is lowercase!)
825
- getCartTotals(cart) // ✅ Works — all carts are server carts now
826
- result.checkoutId (guest checkout) // ⚠️ Check result.tracked first! It's a union type
827
- ```
828
-
829
- **Key distinctions:**
830
-
831
- - **OrderItem** (from orders): Flat structure — `item.price`, `item.name`, `item.image`
832
- - **CartItem / CheckoutLineItem**: Nested structure — `item.unitPrice`, `item.product.name`, `item.product.images`
833
- - **`getCartTotals()`** works on all carts — guests now use server-side session carts with full `subtotal`/`discountAmount` fields.
834
- - **`GuestCheckoutStartResponse`** is a union type — always check `result.tracked` before accessing `result.checkoutId`
835
- - **`WaitForOrderResult`** has `result.status.orderNumber`, NOT `result.orderNumber`. But `completeGuestCheckout()` returns `GuestOrderResponse` which DOES have `result.orderNumber` directly.
836
- - **Cart state**: Use `useState<Cart | null>(null)` and load with `smartGetCart()` in `useEffect` — all carts are server-side now, no hydration mismatch issues.
837
-
838
- ---
839
-
840
- ## Full SDK Documentation
841
-
842
- For complete API reference and working code examples:
843
- **https://brainerce.com/docs/sdk**