npm - brainerce - Versions diffs - 1.36.3 → 1.36.5 - Mend

brainerce 1.36.3 → 1.36.5

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.

Files changed (6) hide show

package/README.md CHANGED Viewed

@@ -100,6 +100,8 @@ Violating any of these causes production incidents or broken orders. Read them b
 - NEVER hardcode currency, locale, or language strings — read them from `getStoreInfo()`.
 - NEVER format prices with `toFixed(2)` — use `formatPrice()` from the SDK.
 - When i18n is enabled, call `client.setLocale(locale)` at app init and include a language switcher. For RTL locales (`he`, `ar`), set `<html dir="rtl">` — do NOT add `flex-row-reverse` on top.
+- Call `setLocale()` **before `createCheckout()`** — the order captures the active locale (`order.locale`), which drives the confirmation-email language AND the product names shown in order history. Without it, orders and their emails fall back to the store default language. Search also needs the locale active to match translated names.
+- Built-in order emails are localized for English and Hebrew; for other languages the merchant must add a custom email template per language (otherwise the email falls back to English).
 ### Type safety
@@ -2206,7 +2208,8 @@ interface Checkout {
   subtotal: string;
   discountAmount: string;
   shippingAmount: string;
-  taxAmount: string;
+  taxAmount: string;          // "0" in inclusive (VAT) mode — see taxBreakdown.totalTax
+  taxBreakdown?: TaxBreakdown | null; // { totalTax, pricesIncludeTax, breakdown[] }
   total: string;
   couponCode?: string | null;
   items: CheckoutLineItem[];

package/dist/index.d.mts CHANGED Viewed

@@ -1139,8 +1139,15 @@ interface Order {
     }> | null;
     /** Shipping cost */
     shippingAmount?: string | null;
-    /** Tax amount */
+    /** Tax amount. In inclusive (VAT) mode this is `"0"` — read the included VAT
+     *  from {@link Order.taxBreakdown}.totalTax instead. */
     taxAmount?: string | null;
+    /**
+     * Frozen tax breakdown snapshot. In inclusive (VAT) pricing `taxAmount` is 0
+     * and the real VAT lives here (`taxBreakdown.totalTax`, with
+     * `pricesIncludeTax: true`). Use it to display "incl. VAT" on receipts.
+     */
+    taxBreakdown?: TaxBreakdown | null;
     createdAt: string;
     /** Payment method used (e.g., "card", "paypal", "cash_on_delivery"). */
     paymentMethod?: string | null;
@@ -2204,6 +2211,12 @@ interface TaxBreakdown {
     total: number;
     /** Itemized tax breakdown */
     breakdown: TaxBreakdownItem[];
+    /**
+     * True when the store's prices already include tax (inclusive/VAT mode). In
+     * that mode `totalTax` is the VAT backed out of the displayed price — it is
+     * already part of `total`, not added on top. Display it as "incl. VAT".
+     */
+    pricesIncludeTax?: boolean;
     /** Currency code */
     currency?: string;
 }

package/dist/index.d.ts CHANGED Viewed

@@ -1139,8 +1139,15 @@ interface Order {
     }> | null;
     /** Shipping cost */
     shippingAmount?: string | null;
-    /** Tax amount */
+    /** Tax amount. In inclusive (VAT) mode this is `"0"` — read the included VAT
+     *  from {@link Order.taxBreakdown}.totalTax instead. */
     taxAmount?: string | null;
+    /**
+     * Frozen tax breakdown snapshot. In inclusive (VAT) pricing `taxAmount` is 0
+     * and the real VAT lives here (`taxBreakdown.totalTax`, with
+     * `pricesIncludeTax: true`). Use it to display "incl. VAT" on receipts.
+     */
+    taxBreakdown?: TaxBreakdown | null;
     createdAt: string;
     /** Payment method used (e.g., "card", "paypal", "cash_on_delivery"). */
     paymentMethod?: string | null;
@@ -2204,6 +2211,12 @@ interface TaxBreakdown {
     total: number;
     /** Itemized tax breakdown */
     breakdown: TaxBreakdownItem[];
+    /**
+     * True when the store's prices already include tax (inclusive/VAT mode). In
+     * that mode `totalTax` is the VAT backed out of the displayed price — it is
+     * already part of `total`, not added on top. Display it as "incl. VAT".
+     */
+    pricesIncludeTax?: boolean;
     /** Currency code */
     currency?: string;
 }

package/dist/index.js CHANGED Viewed

@@ -955,7 +955,7 @@ var BrainerceClient = class {
     if (!this.storeId) {
       throw new BrainerceError("storeId is required for storefront requests", 400);
     }
-    const url = new URL(`${this.baseUrl}/stores/${encodePathSegment(this.storeId)}${path}`);
+    const url = new URL(`${this.baseUrl}/api/stores/${encodePathSegment(this.storeId)}${path}`);
     if (queryParams) {
       Object.entries(queryParams).forEach(([key, value]) => {
         if (value !== void 0) {

package/dist/index.mjs CHANGED Viewed

@@ -885,7 +885,7 @@ var BrainerceClient = class {
     if (!this.storeId) {
       throw new BrainerceError("storeId is required for storefront requests", 400);
     }
-    const url = new URL(`${this.baseUrl}/stores/${encodePathSegment(this.storeId)}${path}`);
+    const url = new URL(`${this.baseUrl}/api/stores/${encodePathSegment(this.storeId)}${path}`);
     if (queryParams) {
       Object.entries(queryParams).forEach(([key, value]) => {
         if (value !== void 0) {

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "brainerce",
-  "version": "1.36.3",
+  "version": "1.36.5",
   "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.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",