brainerce 1.47.1 → 1.48.0

package/README.md

@@ -32,29 +32,30 @@ yarn add brainerce
 
 Every Brainerce storefront must include **all mandatory features** below. Features auto-hide when the underlying capability is disabled, so build them all anyway — they'll appear the moment the store owner enables them.
 
-| Feature                                                 | SDK entry point                                                                                                             | Mandatory   |
-| ------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | ----------- |
-| Product list with search, filter, pagination            | `client.getProducts()`, `client.getSearchSuggestions(query)`                                                                | ✅          |
-| Product detail with variant picker, stock, price        | `client.getProductBySlug()` + helpers                                                                                       | ✅          |
-| Buyer customization fields (engraving, uploads, select) | `product.customizationFields`, `client.uploadCustomizationFile()`                                                           | ✅          |
-| Cart (add, update, remove, coupon, totals)              | `client.addToCart()`, `getCartTotals(cart)`                                                                                 | ✅          |
-| Inventory reservation countdown                         | Cart expiry timestamp from `client.getCart()`                                                                               | ✅          |
-| Full checkout end-to-end with payment                   | `setShippingAddress → selectShippingMethod → getPaymentProviders → pay → handlePaymentSuccess → waitForOrder`               | ✅          |
-| Order confirmation (clear cart + wait for real order)   | `client.handlePaymentSuccess()`, `client.waitForOrder()`                                                                    | ✅          |
-| Register + email verification flow                      | `client.registerCustomer()`, `client.verifyEmail()`                                                                         | ✅          |
-| Login + verification branch                             | `client.loginCustomer()`                                                                                                    | ✅          |
-| Forgot / reset password                                 | `client.forgotPassword()`, `client.resetPassword()`                                                                         | ✅          |
-| OAuth sign-in buttons + callback handler                | `client.getAvailableOAuthProviders()`                                                                                       | ✅          |
-| Account area (profile + order history)                  | `client.getMyProfile()`, `client.getMyOrders()`                                                                             | ✅          |
-| Loyalty & rewards (points balance + tiers + redeem)     | `client.getLoyaltyStatus()`, `client.getAvailableRewards()`, `client.getRecommendedReward()`, `client.redeemLoyaltyReward(id)`, `client.reportSocialShare()` | conditional |
-| Loyalty paid membership (premium subscription)          | `client.getMembershipPlans()`, `client.getMySavedPaymentMethods()`, `client.subscribeToMembership(params)`, `client.cancelMembership()` | conditional |
-| Global header: cart count + search autocomplete         | `client.getCart()`, `client.getSearchSuggestions(query)`                                                                    | ✅          |
-| Discount banners + product badges                       | `client.getDiscountBanners()`, `client.getProductDiscountBadge(productId)`                                                  | ✅          |
-| Product reviews on PDP + JSON-LD aggregateRating        | `client.listProductReviews(id)`, `client.submitProductReview(id, …)`                                                        | ✅          |
-| Site chrome (header + footer + announcement bar)        | `client.content.header.get()`, `client.content.footer.get()`, `client.content.announcement.list()`                          | ✅          |
-| FAQ page                                                | `client.content.faq.get('main', locale)`                                                                                    | conditional |
-| Static pages catch-all (`/pages/[slug]`)                | `client.content.page.getBySlug(slug, locale)`                                                                               | conditional |
-| Multi-language + RTL (when i18n enabled)                | `client.setLocale()`, `client.getStoreDirection(locale)`                                                                    | conditional |
+| Feature                                                  | SDK entry point                                                                                                                                              | Mandatory   |
+| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
+| Product list with search, filter, pagination             | `client.getProducts()`, `client.getSearchSuggestions(query)`                                                                                                 | ✅          |
+| Product detail with variant picker, stock, price         | `client.getProductBySlug()` + helpers                                                                                                                        | ✅          |
+| Buyer customization fields (engraving, uploads, select)  | `product.customizationFields`, `client.uploadCustomizationFile()`                                                                                            | ✅          |
+| Cart (add, update, remove, coupon, totals)               | `client.addToCart()`, `getCartTotals(cart)`                                                                                                                  | ✅          |
+| Inventory reservation countdown                          | Cart expiry timestamp from `client.getCart()`                                                                                                                | ✅          |
+| Full checkout end-to-end with payment                    | `setShippingAddress → selectShippingMethod → getPaymentProviders → pay → handlePaymentSuccess → waitForOrder`                                                | ✅          |
+| Order confirmation (clear cart + wait for real order)    | `client.handlePaymentSuccess()`, `client.waitForOrder()`                                                                                                     | ✅          |
+| Register + email verification flow                       | `client.registerCustomer()`, `client.verifyEmail()`                                                                                                          | ✅          |
+| Login + verification branch                              | `client.loginCustomer()`                                                                                                                                     | ✅          |
+| Forgot / reset password                                  | `client.forgotPassword()`, `client.resetPassword()`                                                                                                          | ✅          |
+| OAuth sign-in buttons + callback handler                 | `client.getAvailableOAuthProviders()`                                                                                                                        | ✅          |
+| Account area (profile + order history)                   | `client.getMyProfile()`, `client.getMyOrders()`                                                                                                              | ✅          |
+| Loyalty & rewards (points balance + tiers + redeem)      | `client.getLoyaltyStatus()`, `client.getAvailableRewards()`, `client.getRecommendedReward()`, `client.redeemLoyaltyReward(id)`, `client.reportSocialShare()` | conditional |
+| Loyalty paid membership (premium subscription)           | `client.getMembershipPlans()`, `client.getMySavedPaymentMethods()`, `client.subscribeToMembership(params)`, `client.cancelMembership()`                      | conditional |
+| Embeddable loyalty widget (points + rewards on ANY site) | `client.getLoyaltyWidgetSession()`                                                                                                                           | conditional |
+| Global header: cart count + search autocomplete          | `client.getCart()`, `client.getSearchSuggestions(query)`                                                                                                     | ✅          |
+| Discount banners + product badges                        | `client.getDiscountBanners()`, `client.getProductDiscountBadge(productId)`                                                                                   | ✅          |
+| Product reviews on PDP + JSON-LD aggregateRating         | `client.listProductReviews(id)`, `client.submitProductReview(id, …)`                                                                                         | ✅          |
+| Site chrome (header + footer + announcement bar)         | `client.content.header.get()`, `client.content.footer.get()`, `client.content.announcement.list()`                                                           | ✅          |
+| FAQ page                                                 | `client.content.faq.get('main', locale)`                                                                                                                     | conditional |
+| Static pages catch-all (`/pages/[slug]`)                 | `client.content.page.getBySlug(slug, locale)`                                                                                                                | conditional |
+| Multi-language + RTL (when i18n enabled)                 | `client.setLocale()`, `client.getStoreDirection(locale)`                                                                                                     | conditional |
 
 ---
 
@@ -271,7 +272,7 @@ The SDK exports these utility functions for common UI tasks:
 | `buildArticleJsonLd(post, opts)`               | schema.org Article JSON-LD for blog posts                                                    | See SEO section                                        |
 | `buildOrganizationJsonLd(store, opts)`         | schema.org Organization for the homepage                                                     | See SEO section                                        |
 | `buildBreadcrumbJsonLd(items)`                 | schema.org BreadcrumbList                                                                    | See SEO section                                        |
-| `jsonLdScriptProps(data)`                      | XSS-safe `<script type="application/ld+json">` props                                        | `<script {...jsonLdScriptProps(data)} />`              |
+| `jsonLdScriptProps(data)`                      | XSS-safe `<script type="application/ld+json">` props                                         | `<script {...jsonLdScriptProps(data)} />`              |
 | `getBlogSitemapEntries(client, opts)`          | Paginate published posts into sitemap entries                                                | See SEO section                                        |
 
 ```typescript
@@ -464,15 +465,16 @@ return <div dangerouslySetInnerHTML={{ __html: safeHtml }} className="prose" />;
 
 ### SEO — JSON-LD builders, sitemap helper, IndexNow key, llms.txt
 
-The SDK ships schema.org builders that encode Google's structured-data rules (aggregateRating gated on `reviewCount > 0`, AggregateOffer for VARIABLE products, XSS-safe serialization). Prefer them over hand-rolled JSON-LD:
+The SDK ships schema.org builders that encode Google's structured-data rules (aggregateRating gated on `reviewCount > 0`, AggregateOffer for VARIABLE products, XSS-safe serialization). `buildProductJsonLd`'s Offer also always includes `itemCondition` (hardcoded `NewCondition` — first-party new-goods catalog), `priceValidUntil` when the product has an active sale-price window (`salePriceEndsAt`), and `shippingDetails` when you pass `shipping` (real flat-rate/free zones from `storeInfo.shipping` — omitted entirely, never fabricated, if you don't pass it). Prefer these builders over hand-rolled JSON-LD:
 
 ```tsx
 import {
-  buildProductJsonLd,      // single-product pages ONLY (never listing pages)
-  buildArticleJsonLd,      // blog post pages
-  buildOrganizationJsonLd, // homepage
+  buildProductJsonLd,        // single-product pages ONLY (never listing pages)
+  buildArticleJsonLd,        // blog post pages
+  buildOrganizationJsonLd,   // homepage
+  buildCollectionPageJsonLd, // category landing pages
   buildBreadcrumbJsonLd,
-  jsonLdScriptProps,       // XSS-safe <script> props
+  jsonLdScriptProps,         // XSS-safe <script> props
 } from 'brainerce';
 
 // Blog article page
@@ -487,6 +489,7 @@ import {
   siteUrl: process.env.NEXT_PUBLIC_SITE_URL!,
   path: `/products/${product.slug}`,
   currency: storeInfo.currency,
+  shipping: storeInfo.shipping, // optional — adds shippingDetails when present
 }))} />
 ```
 
@@ -862,6 +865,26 @@ import { getCartTotals } from 'brainerce';
 const totals = getCartTotals(cart); // { subtotal, discount, shipping, total }
 ```
 
+### Detecting a Silent Session Cart Reset
+
+If a guest's stored session cart can no longer be resolved as-is — the fetch
+fails, or the cart was found but is no longer `ACTIVE` (e.g. a prior checkout
+on it already completed) — `smartAddToCart()` / `smartGetCart()` /
+`smartUpdateCartItem()` transparently start a fresh empty cart so the call
+still succeeds. Pass `onCartReset` to the constructor to find out when this
+happens, so you can tell the shopper their cart expired instead of them just
+seeing it empty out:
+
+```typescript
+const client = new BrainerceClient({
+  salesChannelId: 'vc_abc123...',
+  onCartReset: ({ previousCartId, reason }) => {
+    // reason: 'not_found' (fetch failed) | 'not_active' (cart no longer ACTIVE)
+    toast.warn('Your cart session expired — please re-add your items.');
+  },
+});
+```
+
 ### On Login — Merge Guest Cart
 
 ```typescript
@@ -1536,17 +1559,19 @@ interface Product {
   description?: string | null;
   descriptionFormat?: 'text' | 'html' | 'markdown'; // Format of description content
   sku: string;
-  basePrice: number;
-  salePrice?: number | null;
+  basePrice: string; // Decimal as string — use parseFloat() for calculations
+  salePrice?: string | null;
+  salePriceStartsAt?: string | null; // ISO 8601 — sale-price effective window start
+  salePriceEndsAt?: string | null; // ISO 8601 — sale-price window end; feeds buildProductJsonLd's priceValidUntil
   priceMin?: string | null; // Lowest variant price (VARIABLE products only)
   priceMax?: string | null; // Highest variant price (VARIABLE products only)
   priceVaries?: boolean; // true when range should be shown ("₪49 – ₪199")
-  status: 'active' | 'draft';
+  status: string; // e.g. "active" | "draft"
   type: 'SIMPLE' | 'VARIABLE';
   images?: ProductImage[];
   inventory?: InventoryInfo | null;
   variants?: ProductVariant[];
-  categories?: string[];
+  categories?: Array<{ id: string; name: string; slug?: string | null }>; // NOT string[] — use slug to link to /category/{slug}
   tags?: string[];
   createdAt: string;
   updatedAt: string;
@@ -3057,6 +3082,13 @@ const profile = await client.getMyProfile();
 console.log(profile.firstName);
 console.log(profile.email);
 console.log(profile.addresses);
+
+// profile.role is a free-form segment the merchant sets from the dashboard
+// (e.g. "wholesale", "vip") — not customer-editable. Use it to gate custom
+// storefront features/UI: wholesale pricing, a VIP section, etc.
+if (profile.role === 'wholesale') {
+  // show wholesale pricing / a bulk-order UI
+}
 ```
 
 #### Get Customer Orders
@@ -3070,9 +3102,9 @@ const { data: orders, meta } = await client.getMyOrders({
 
 #### Loyalty & Rewards
 
-Storefront-mode only (requires `storeId` + `customerToken`). Let logged-in
-customers check their points balance, enroll, and redeem rewards for one-time
-coupons that apply at checkout.
+Storefront or vibe-coded mode (requires `storeId` or `salesChannelId` +
+`customerToken`). Let logged-in customers check their points balance, enroll,
+and redeem rewards for one-time coupons that apply at checkout.
 
 ```typescript
 // Current status — points balance + program display config + tier progress +
@@ -3149,8 +3181,9 @@ platform emails a one-time gift coupon ahead of their birthday automatically
 
 Stores can offer a paid "premium membership" inside the loyalty program — a
 recurring charge (default every 30 days) that grants a points multiplier and
-other perks. Storefront-mode only, requires `customerToken`. The customer must
-first have a saved card (vault one by checking out with `saveCard: true`).
+other perks. Storefront or vibe-coded mode, requires `customerToken`. The
+customer must first have a saved card (vault one by checking out with
+`saveCard: true`).
 
 ```typescript
 // 1. Plans the store offers (empty if none / program not active).
@@ -3182,6 +3215,26 @@ const cancelled = await client.cancelMembership();
 // pauses the multiplier until the charge clears.
 ```
 
+#### Embeddable Loyalty Widget
+
+Drop the loyalty program into ANY website — not just your SDK-connected
+storefront. Mint a short-lived widget session (never exposes the real
+`customerToken` to the embedding page) and point an `<iframe>` at it. The
+merchant enables this per-domain in the dashboard (Loyalty → Settings →
+Embeddable widget) before it will render anywhere.
+
+```typescript
+client.setCustomerToken(auth.token);
+
+const { embedUrl } = await client.getLoyaltyWidgetSession();
+
+// <iframe src={embedUrl} width="360" height="420" style={{ border: 0 }} />
+```
+
+`embedUrl` expires in ~15 minutes — re-call `getLoyaltyWidgetSession()` before
+that (e.g. on page load) rather than caching it long-term. Storefront or
+vibe-coded mode, requires `customerToken`.
+
 #### Auth Response Type
 
 ```typescript

package/dist/index.d.mts

@@ -76,6 +76,31 @@ interface BrainerceClientOptions {
         statusCode: number;
         path?: string;
     }) => void;
+    /**
+     * Callback fired when the SDK silently resets the guest session cart because
+     * the previously-stored cart could no longer be resolved as-is — either the
+     * fetch failed (network error, 404 — cart deleted/expired) or the cart was
+     * found but is no longer `ACTIVE` (e.g. a prior checkout on it already
+     * completed or the cart was abandoned/merged). In both cases the SDK
+     * transparently creates a fresh empty cart so `smartAddToCart()` /
+     * `smartGetCart()` keep working — this callback is your only signal that it
+     * happened, so the storefront can tell the shopper their cart expired
+     * instead of them just seeing it silently empty out.
+     *
+     * @example
+     * ```typescript
+     * const client = new BrainerceClient({
+     *   salesChannelId: 'vc_abc123...',
+     *   onCartReset: ({ previousCartId, reason }) => {
+     *     toast.warn('Your cart session expired — please re-add your items.');
+     *   },
+     * });
+     * ```
+     */
+    onCartReset?: (info: {
+        previousCartId: string;
+        reason: 'not_found' | 'not_active';
+    }) => void;
     /**
      * Origin header to send with requests.
      * Browsers add this automatically, but Node.js environments (SSR, scripts, npx)
@@ -204,6 +229,26 @@ interface StoreInfo {
     seo?: {
         indexNowKey: string | null;
     };
+    /**
+     * Real merchant-configured shipping rates (sales-channel mode only) —
+     * flat-rate/free zones only, each with a single unconditional price.
+     * Weight/price-tiered and local-pickup rates are excluded because their
+     * cost depends on cart contents, so there's no single number to declare.
+     * Feeds Product JSON-LD `shippingDetails` — pass as `buildProductJsonLd(product, { ..., shipping: storeInfo.shipping })`.
+     */
+    shipping?: ShippingSummaryEntry[];
+}
+/** One flat-rate/free shipping zone, as exposed by `StoreInfo.shipping`. */
+interface ShippingSummaryEntry {
+    /** ISO 3166-1 alpha-2 country codes this rate applies to. */
+    countries: string[];
+    rateType: 'FLAT_RATE' | 'FREE';
+    /** Shipping cost in the store's currency. `0` for FREE, `null` if a FLAT_RATE has no configured amount. */
+    amount: number | null;
+    minDeliveryDays: number | null;
+    maxDeliveryDays: number | null;
+    /** Order-processing time in business days before the item ships. */
+    handlingTime: number | null;
 }
 /** Multi-language configuration exposed to the storefront */
 interface I18nSettings {
@@ -254,6 +299,8 @@ interface CustomerProfile {
     phone?: string;
     emailVerified: boolean;
     acceptsMarketing: boolean;
+    /** Free-form segment set by the merchant (e.g. "wholesale", "vip") — use to gate custom storefront features. Admin-set only, never customer-editable. */
+    role?: string;
     addresses: CustomerAddress[];
     createdAt: string;
     updatedAt: string;
@@ -497,6 +544,10 @@ interface Product {
      * `SIMPLE` products it is the product's own stored sale price.
      */
     salePrice?: string | null;
+    /** ISO 8601 — start of the sale-price effective window. `null` when unset (sale has no window). */
+    salePriceStartsAt?: string | null;
+    /** ISO 8601 — end of the sale-price effective window. Feeds Product JSON-LD `priceValidUntil`. `null` when unset. */
+    salePriceEndsAt?: string | null;
     /** Cost price as string. Use parseFloat() for calculations. */
     costPrice?: string | null;
     /** Lowest effective variant price (VARIABLE products only). String Decimal, e.g. "19.99". */
@@ -526,13 +577,15 @@ interface Product {
     inventory?: InventoryInfo | null;
     variants?: ProductVariant[];
     /**
-     * Categories as objects with `id` and `name`.
-     * NOT string[] - each category is `{ id: string; name: string }`.
-     * Access: `product.categories?.map(cat => cat.name)`
+     * Categories as objects with `id`, `name`, and `slug`.
+     * NOT string[] - each category is `{ id: string; name: string; slug?: string | null }`.
+     * Access: `product.categories?.map(cat => cat.name)`. Use `slug` to link to
+     * that category's `/category/{slug}` landing page.
      */
     categories?: Array<{
         id: string;
         name: string;
+        slug?: string | null;
     }>;
     /** Brands as objects with id and name */
     brands?: Array<{
@@ -704,6 +757,10 @@ interface ProductVariant {
     price?: string | null;
     /** Variant sale price as string. Use parseFloat() for calculations. */
     salePrice?: string | null;
+    /** Variant unit cost (COGS) override as string — falls back to the product
+     *  costPrice in margin analytics. Admin (apiKey) reads only; public
+     *  storefront responses never include it. */
+    costPrice?: string | null;
     /** PRD §23: variant price converted to the region's currency via the daily
      *  FX snapshot. Present only with `getProducts({ regionId })`. Display-only. */
     displayPrice?: string;
@@ -1808,6 +1865,8 @@ interface Customer {
     emailVerified: boolean;
     acceptsMarketing: boolean;
     tags: string[];
+    /** Free-form segment set by the merchant (e.g. "wholesale", "vip") — use to gate custom storefront features. Admin-set only, never customer-editable. */
+    role?: string;
     totalOrders: number;
     lastOrderAt?: string;
     metadata?: Record<string, unknown>;
@@ -1907,6 +1966,8 @@ interface CreateCustomerDto {
     password?: string;
     acceptsMarketing?: boolean;
     tags?: string[];
+    /** Free-form merchant-set segment (e.g. "wholesale", "vip"), max 50 chars. */
+    role?: string;
     metadata?: Record<string, unknown>;
 }
 interface UpdateCustomerDto {
@@ -1916,6 +1977,8 @@ interface UpdateCustomerDto {
     lastName?: string;
     acceptsMarketing?: boolean;
     tags?: string[];
+    /** Free-form merchant-set segment. Pass '' to clear it. */
+    role?: string;
     metadata?: Record<string, unknown>;
 }
 interface CustomerQueryParams {
@@ -1923,6 +1986,8 @@ interface CustomerQueryParams {
     limit?: number;
     search?: string;
     hasAccount?: boolean;
+    /** Filter by merchant-set customer role/segment (exact match, case-insensitive). */
+    role?: string;
     sortBy?: 'createdAt' | 'email' | 'firstName' | 'lastName' | 'lastOrderAt';
     sortOrder?: 'asc' | 'desc';
 }
@@ -3120,6 +3185,8 @@ interface CreateVariantDto {
     attributes?: Record<string, string>;
     price?: number;
     salePrice?: number;
+    /** Variant unit cost (COGS) override — falls back to product costPrice in margin analytics. */
+    costPrice?: number;
     inventory?: number;
     image?: unknown;
     position?: number;
@@ -3131,6 +3198,8 @@ interface UpdateVariantDto {
     attributes?: Record<string, string>;
     price?: number;
     salePrice?: number;
+    /** Variant unit cost (COGS) override. Pass null to clear (falls back to product costPrice). */
+    costPrice?: number | null;
     image?: string | unknown;
     position?: number;
     status?: VariantStatus;
@@ -3149,6 +3218,8 @@ interface BulkVariantInput {
     attributes: Record<string, string>;
     price?: number | null;
     salePrice?: number | null;
+    /** Variant unit cost (COGS) override. null clears (falls back to product costPrice). */
+    costPrice?: number | null;
     stock: number;
     position?: number;
     image?: unknown | null;
@@ -6012,6 +6083,7 @@ declare class BrainerceClient {
     private readonly origin?;
     private readonly proxyMode;
     private readonly onAuthError?;
+    private readonly onCartReset?;
     /** Active locale for content translation. When set, content endpoints return translated data. */
     private locale?;
     constructor(options: BrainerceClientOptions);
@@ -7301,6 +7373,8 @@ declare class BrainerceClient {
         lastName?: string;
         phone?: string;
         emailVerified: boolean;
+        /** Free-form segment set by the merchant (e.g. "wholesale", "vip") — use to gate custom storefront features. */
+        role?: string;
     }>;
     /**
      * Get all addresses for a customer
@@ -9283,6 +9357,25 @@ declare class BrainerceClient {
      * ```
      */
     cancelMembership(): Promise<PaidMembershipInfo>;
+    /**
+     * Mint a short-lived session for the embeddable loyalty widget (Phase 5) and
+     * return the ready-to-use iframe URL. Requires customerToken. The returned
+     * `embedUrl` is safe to drop straight into an `<iframe src>` — it carries a
+     * scoped ~15-minute session token, never the real customerToken. Re-call this
+     * before the iframe reloads (e.g. on page navigation) to refresh it.
+     *
+     * @example
+     * ```typescript
+     * const { embedUrl } = await client.getLoyaltyWidgetSession();
+     * // <iframe src={embedUrl} width="360" height="420" />
+     * ```
+     */
+    getLoyaltyWidgetSession(): Promise<{
+        sessionId: string;
+        expiresAt: string;
+        storeId: string;
+        embedUrl: string;
+    }>;
     /**
      * Get the current customer's orders (requires customerToken)
      * Works in vibe-coded and storefront modes
@@ -10503,7 +10596,7 @@ declare class BrainerceError extends Error {
     constructor(message: string, statusCode: number, details?: unknown);
 }
 
-declare const SDK_VERSION = "1.45.0";
+declare const SDK_VERSION = "1.48.0";
 
 /**
  * Verify a webhook signature from Brainerce
@@ -10686,6 +10779,8 @@ declare function buildProductJsonLd(product: Product, opts: JsonLdOptions & {
     currency: string;
     /** Brand display name; falls back to product.brands[0]. */
     brandName?: string;
+    /** Flat-rate/free shipping zones (from `StoreInfo.shipping`). Omitted entirely when not provided — no fabricated shipping cost. */
+    shipping?: ShippingSummaryEntry[];
 }): JsonLd;
 /**
  * schema.org/Organization for the homepage (Knowledge Panel + AI-answer
@@ -10786,4 +10881,4 @@ interface CategorySitemapOptions {
  */
 declare function getCategorySitemapEntries(client: BrainerceClient, opts: CategorySitemapOptions): Promise<SitemapEntry[]>;
 
-export { type AddToCartDto, type AddressDetailsResult, type AddressSuggestion, type AnnouncementContent, type AnnouncementSeverity, type AppliedDiscount, type ApplyCouponDto, type AttachModifierGroupInput, type Attribute, type AttributeOption, type AttributeSource, type BlogSitemapOptions, type BrainerceApiError, BrainerceClient, type BrainerceClientOptions, BrainerceError, type Brand, type BulkInventoryResponse, type BulkSaveVariantsDto, type BulkSaveVariantsResponse, type BulkVariantInput, type Cart, type CartAppliedDiscount, type CartBundleOffer, type CartBundlesResponse, type CartIncludeOption, type CartIncludeOptions, type CartItem, type CartItemModifierLine, type CartNudge, type CartRecommendationsResponse, type CartStatus, type CartUpgradeSuggestion, type CartUpgradesResponse, type CartWithIncludes, type Category, type CategoryDetail, type CategoryNode, type CategorySitemapOptions, type CategorySuggestion, type Checkout, type CheckoutAddress, type CheckoutBumpsResponse, type CheckoutCustomFieldDefinition, type CheckoutFieldPricing, type CheckoutFieldVisibility, type CheckoutLineItem, type CheckoutPrefillData, type CheckoutStatus, type CompleteCheckoutResponse, type CompleteDraftDto, type ConfigureOAuthProviderDto as ConfigureOAuthProviderInput, type ConflictStatus, type ConnectorPlatform, type ContactFormFieldType, type ContactFormFieldValidation, type ContactFormPublic, type ContactFormPublicField, type ContactFormSummary, type Content, type ContentDataMap, type ContentStatus, type ContentSummary, type ContentType, type Coupon, type CouponCreateResponse, type CouponQueryParams, type CouponStatus, type CouponType, type CouponValidationWarning, type CreateAddressDto, type CreateAttributeDto as CreateAttributeInput, type CreateAttributeOptionDto as CreateAttributeOptionInput, type CreateBrandDto as CreateBrandInput, type CreateCategoryDto as CreateCategoryInput, type CreateCheckoutDto, type CreateContentInput, type CreateCouponDto, type CreateCustomApiDto, type CreateCustomerDto, type CreateEmailTemplateDto as CreateEmailTemplateInput, type CreateGuestOrderDto, type CreateInquiryInput, type CreateInquiryResponse, type CreateMetafieldDefinitionDto as CreateMetafieldDefinitionInput, type CreateModifierGroupInput, type CreateModifierInput, type CreateOrderDto, type CreateProductDto, type CreateRefundDto, type CreateShippingRateDto as CreateShippingRateInput, type CreateShippingZoneDto as CreateShippingZoneInput, type CreateTagDto as CreateTagInput, type CreateTaxRateDto as CreateTaxRateInput, type CreateVariantDto, type CustomApiAuthType, type CustomApiConnectionStatus, type CustomApiCredentials, type CustomApiIntegration, type CustomApiSyncConfig, type CustomApiSyncDirection, type CustomApiTestResult, type Customer, type CustomerAddress, type CustomerAuthResponse, type CustomerOAuthProvider, type CustomerProfile, type CustomerQueryParams, type DeleteProductResponse, type DiscountBanner, type DiscountRuleType, type DownloadFile, type DraftLineItem, type EditInventoryDto, type EmailDomain, type EmailEventSettings, type EmailEventType, type EmailSettings, type EmailTemplate, type EmailTemplatePreview, type EmailTemplatesResponse, type EmailVerificationResponse, type ExtendReservationResponse, type FaqContent, type FaqItem, type FooterColumn, type FooterContent, type FooterLink, type FooterSocialLink, type FormatPriceOptions, type FormatProductPriceOptions, type FreeAllocationPolicy, type FulfillOrderDto, type GuestCheckoutStartResponse, type GuestOrderResponse, type HeaderContent, type HeaderCta, type HeaderLogo, type HeaderNavItem, type InsufficientStockError, type InventoryInfo, type InventoryReservationStrategy, type InventorySyncStatus, type InventoryTrackingMode, type InvitationStatus, type InviteMemberDto as InviteMemberInput, type InviteStoreMemberDto as InviteStoreMemberInput, type JsonLdOptions, type ListModifierGroupsParams, type LocalCart, type LocalCartItem, type LockedVariant, type LoyaltyNextTierSummary, type LoyaltyReward, type LoyaltyStatus, type LoyaltyTierSummary, type MergeCartsDto, type MetafieldConflict, type MetafieldConflictResolution, type MetafieldDefinition, type MetafieldType, type Modifier, type ModifierGroup, type ModifierSelection, type ModifierSelectionType, type ModifierValidationCode, type ModifierValidationError, type MyProductReview, type OAuthAuthorizeResponse, type OAuthCallbackResponse, type OAuthConnection, type OAuthConnectionsResponse, type OAuthProviderConfig, type OAuthProviderType, type OAuthProvidersResponse, type Order, type OrderAddress, type OrderBump, type OrderCustomer, type OrderDownloadLink, type OrderItem, type OrderQueryParams, type OrderStatus, type OrderStatusChange, type PageContent, type PageSeo, type PaginatedResponse, type PaymentClientSdk, type PaymentConfig, type PaymentIntent, type PaymentProvider, type PaymentProviderConfig, type PaymentProvidersConfig, type PaymentStatus, type PaymentUrlOptions, type PickupLocation, type PlatformCouponCapabilities, type PlatformMetafieldMetadata, type PreviewEmailTemplateDto as PreviewEmailTemplateInput, type Product, type ProductAttributeInput, type ProductAvailability, type ProductCustomizationField, type ProductDiscount, type ProductDiscountBadge, type ProductImage, type ProductMetafield, type ProductMetafieldValue, type ProductModifierGroupAttachment, type ProductQueryParams, type ProductRecommendation, type ProductRecommendationsResponse, type ProductRelationType, type ProductReview, type ProductReviewAdmin, type ProductSuggestion, type ProductVariant, type PublicMetafieldDefinition, type PublishProductResponse, RTL_LOCALES, type RecommendationVariant, type ReconcileInventoryResponse, type RedeemRewardResult, type ReferralInfo, type Refund, type RefundLineItem, type RefundLineItemResponse, type RefundType, type RegisterCustomerDto, type ReservationInfo, type ResolveMetafieldConflictDto as ResolveMetafieldConflictInput, type ResolveSyncConflictDto as ResolveSyncConflictInput, type RichTextContent, SDK_VERSION, type SearchSuggestions, type SelectPickupLocationDto, type SelectShippingMethodDto, type SendInvoiceDto, type SessionCartRef, type SetBillingAddressDto, type SetCheckoutCustomFieldsDto, type SetCheckoutCustomerDto, type SetDefinitionProductsDto as SetDefinitionProductsInput, type SetMetafieldPlatformsDto as SetMetafieldPlatformsInput, type SetShippingAddressDto, type SetShippingAddressResponse, type ShippingDestinations, type ShippingLine, type ShippingRate, type ShippingRateConfig, type ShippingRateType, type ShippingZone, type ShippingZoneQueryParams, type SitemapEntry, type StockAvailabilityRequest, type StockAvailabilityResponse, type StockAvailabilityResult, type StoreInfo, type StoreInvitation, type StoreInvitationDetails, type StoreMember, type StorePermission, type StoreRole, type StoreTeamResponse, type SubmitProductReviewInput, type SupportedLocaleObject, type SyncConflict, type SyncConflictResolution, type SyncJob, type Tag, type TaxBreakdown, type TaxBreakdownItem, type TaxRate, type TaxonomyQueryParams, type TeamInvitation, type TeamInvitationsResponse, type TeamMember, type TeamMembersResponse, type TeamRole, type UpdateAddressDto, type UpdateAttachmentInput, type UpdateAttributeDto as UpdateAttributeInput, type UpdateAttributeOptionDto as UpdateAttributeOptionInput, type UpdateBrandDto as UpdateBrandInput, type UpdateCartItemDto, type UpdateCategoryDto as UpdateCategoryInput, type UpdateContentInput, type UpdateCouponDto, type UpdateCustomApiDto, type UpdateCustomerDto, type UpdateDraftDto, type UpdateEmailSettingsDto as UpdateEmailSettingsInput, type UpdateEmailTemplateDto as UpdateEmailTemplateInput, type UpdateInventoryDto, type UpdateMemberRoleDto as UpdateMemberRoleInput, type UpdateMetafieldDefinitionDto as UpdateMetafieldDefinitionInput, type UpdateModifierGroupInput, type UpdateModifierInput, type UpdateOAuthProviderDto as UpdateOAuthProviderInput, type UpdateOrderDto, type UpdateOrderShippingDto, type UpdateProductDto, type UpdateShippingRateDto as UpdateShippingRateInput, type UpdateShippingZoneDto as UpdateShippingZoneInput, type UpdateStoreMemberDto as UpdateStoreMemberInput, type UpdateTagDto as UpdateTagInput, type UpdateTaxRateDto as UpdateTaxRateInput, type UpdateVariantDto, type UpdateVariantInventoryDto, type UpsertProductMetafieldDto as UpsertProductMetafieldInput, type UserStore, type UserStorePermissions, type VariantInventoryResponse, type VariantPlatformOverlay, type VariantStatus, type WaitForOrderOptions, type WaitForOrderResult, type WebhookEvent, type WebhookEventType, type WriteProductReviewInput, buildArticleJsonLd, buildBreadcrumbJsonLd, buildCollectionPageJsonLd, buildOrganizationJsonLd, buildProductJsonLd, buildWebsiteJsonLd, createWebhookHandler, deriveSeoDescription, enableDevGuards, formatMoney, formatPrice, formatProductPrice, formatVariantPrice, getBlogSitemapEntries, getCartItemImage, getCartItemName, getCartTotals, getCategorySitemapEntries, getDescriptionContent, getDirectionForLocale, formatPrice as getPriceDisplay, getProductCustomizationFields, getProductMetafield, getProductMetafieldValue, getProductMetafieldsByType, getProductPrice, getProductPriceInfo, getProductSwatches, getStockStatus, getVariantOptions, getVariantPrice, isAllowedPaymentUrl, isCouponApplicableToProduct, isHtmlDescription, isWebhookEventType, jsonLdScriptProps, parseWebhookEvent, safePaymentRedirect, stripHtml, verifyWebhook };
+export { type AddToCartDto, type AddressDetailsResult, type AddressSuggestion, type AnnouncementContent, type AnnouncementSeverity, type AppliedDiscount, type ApplyCouponDto, type AttachModifierGroupInput, type Attribute, type AttributeOption, type AttributeSource, type BlogSitemapOptions, type BrainerceApiError, BrainerceClient, type BrainerceClientOptions, BrainerceError, type Brand, type BulkInventoryResponse, type BulkSaveVariantsDto, type BulkSaveVariantsResponse, type BulkVariantInput, type Cart, type CartAppliedDiscount, type CartBundleOffer, type CartBundlesResponse, type CartIncludeOption, type CartIncludeOptions, type CartItem, type CartItemModifierLine, type CartNudge, type CartRecommendationsResponse, type CartStatus, type CartUpgradeSuggestion, type CartUpgradesResponse, type CartWithIncludes, type Category, type CategoryDetail, type CategoryNode, type CategorySitemapOptions, type CategorySuggestion, type Checkout, type CheckoutAddress, type CheckoutBumpsResponse, type CheckoutCustomFieldDefinition, type CheckoutFieldPricing, type CheckoutFieldVisibility, type CheckoutLineItem, type CheckoutPrefillData, type CheckoutStatus, type CompleteCheckoutResponse, type CompleteDraftDto, type ConfigureOAuthProviderDto as ConfigureOAuthProviderInput, type ConflictStatus, type ConnectorPlatform, type ContactFormFieldType, type ContactFormFieldValidation, type ContactFormPublic, type ContactFormPublicField, type ContactFormSummary, type Content, type ContentDataMap, type ContentStatus, type ContentSummary, type ContentType, type Coupon, type CouponCreateResponse, type CouponQueryParams, type CouponStatus, type CouponType, type CouponValidationWarning, type CreateAddressDto, type CreateAttributeDto as CreateAttributeInput, type CreateAttributeOptionDto as CreateAttributeOptionInput, type CreateBrandDto as CreateBrandInput, type CreateCategoryDto as CreateCategoryInput, type CreateCheckoutDto, type CreateContentInput, type CreateCouponDto, type CreateCustomApiDto, type CreateCustomerDto, type CreateEmailTemplateDto as CreateEmailTemplateInput, type CreateGuestOrderDto, type CreateInquiryInput, type CreateInquiryResponse, type CreateMetafieldDefinitionDto as CreateMetafieldDefinitionInput, type CreateModifierGroupInput, type CreateModifierInput, type CreateOrderDto, type CreateProductDto, type CreateRefundDto, type CreateShippingRateDto as CreateShippingRateInput, type CreateShippingZoneDto as CreateShippingZoneInput, type CreateTagDto as CreateTagInput, type CreateTaxRateDto as CreateTaxRateInput, type CreateVariantDto, type CustomApiAuthType, type CustomApiConnectionStatus, type CustomApiCredentials, type CustomApiIntegration, type CustomApiSyncConfig, type CustomApiSyncDirection, type CustomApiTestResult, type Customer, type CustomerAddress, type CustomerAuthResponse, type CustomerOAuthProvider, type CustomerProfile, type CustomerQueryParams, type DeleteProductResponse, type DiscountBanner, type DiscountRuleType, type DownloadFile, type DraftLineItem, type EditInventoryDto, type EmailDomain, type EmailEventSettings, type EmailEventType, type EmailSettings, type EmailTemplate, type EmailTemplatePreview, type EmailTemplatesResponse, type EmailVerificationResponse, type ExtendReservationResponse, type FaqContent, type FaqItem, type FooterColumn, type FooterContent, type FooterLink, type FooterSocialLink, type FormatPriceOptions, type FormatProductPriceOptions, type FreeAllocationPolicy, type FulfillOrderDto, type GuestCheckoutStartResponse, type GuestOrderResponse, type HeaderContent, type HeaderCta, type HeaderLogo, type HeaderNavItem, type InsufficientStockError, type InventoryInfo, type InventoryReservationStrategy, type InventorySyncStatus, type InventoryTrackingMode, type InvitationStatus, type InviteMemberDto as InviteMemberInput, type InviteStoreMemberDto as InviteStoreMemberInput, type JsonLdOptions, type ListModifierGroupsParams, type LocalCart, type LocalCartItem, type LockedVariant, type LoyaltyNextTierSummary, type LoyaltyReward, type LoyaltyStatus, type LoyaltyTierSummary, type MergeCartsDto, type MetafieldConflict, type MetafieldConflictResolution, type MetafieldDefinition, type MetafieldType, type Modifier, type ModifierGroup, type ModifierSelection, type ModifierSelectionType, type ModifierValidationCode, type ModifierValidationError, type MyProductReview, type OAuthAuthorizeResponse, type OAuthCallbackResponse, type OAuthConnection, type OAuthConnectionsResponse, type OAuthProviderConfig, type OAuthProviderType, type OAuthProvidersResponse, type Order, type OrderAddress, type OrderBump, type OrderCustomer, type OrderDownloadLink, type OrderItem, type OrderQueryParams, type OrderStatus, type OrderStatusChange, type PageContent, type PageSeo, type PaginatedResponse, type PaymentClientSdk, type PaymentConfig, type PaymentIntent, type PaymentProvider, type PaymentProviderConfig, type PaymentProvidersConfig, type PaymentStatus, type PaymentUrlOptions, type PickupLocation, type PlatformCouponCapabilities, type PlatformMetafieldMetadata, type PreviewEmailTemplateDto as PreviewEmailTemplateInput, type Product, type ProductAttributeInput, type ProductAvailability, type ProductCustomizationField, type ProductDiscount, type ProductDiscountBadge, type ProductImage, type ProductMetafield, type ProductMetafieldValue, type ProductModifierGroupAttachment, type ProductQueryParams, type ProductRecommendation, type ProductRecommendationsResponse, type ProductRelationType, type ProductReview, type ProductReviewAdmin, type ProductSuggestion, type ProductVariant, type PublicMetafieldDefinition, type PublishProductResponse, RTL_LOCALES, type RecommendationVariant, type ReconcileInventoryResponse, type RedeemRewardResult, type ReferralInfo, type Refund, type RefundLineItem, type RefundLineItemResponse, type RefundType, type RegisterCustomerDto, type ReservationInfo, type ResolveMetafieldConflictDto as ResolveMetafieldConflictInput, type ResolveSyncConflictDto as ResolveSyncConflictInput, type RichTextContent, SDK_VERSION, type SearchSuggestions, type SelectPickupLocationDto, type SelectShippingMethodDto, type SendInvoiceDto, type SessionCartRef, type SetBillingAddressDto, type SetCheckoutCustomFieldsDto, type SetCheckoutCustomerDto, type SetDefinitionProductsDto as SetDefinitionProductsInput, type SetMetafieldPlatformsDto as SetMetafieldPlatformsInput, type SetShippingAddressDto, type SetShippingAddressResponse, type ShippingDestinations, type ShippingLine, type ShippingRate, type ShippingRateConfig, type ShippingRateType, type ShippingSummaryEntry, type ShippingZone, type ShippingZoneQueryParams, type SitemapEntry, type StockAvailabilityRequest, type StockAvailabilityResponse, type StockAvailabilityResult, type StoreInfo, type StoreInvitation, type StoreInvitationDetails, type StoreMember, type StorePermission, type StoreRole, type StoreTeamResponse, type SubmitProductReviewInput, type SupportedLocaleObject, type SyncConflict, type SyncConflictResolution, type SyncJob, type Tag, type TaxBreakdown, type TaxBreakdownItem, type TaxRate, type TaxonomyQueryParams, type TeamInvitation, type TeamInvitationsResponse, type TeamMember, type TeamMembersResponse, type TeamRole, type UpdateAddressDto, type UpdateAttachmentInput, type UpdateAttributeDto as UpdateAttributeInput, type UpdateAttributeOptionDto as UpdateAttributeOptionInput, type UpdateBrandDto as UpdateBrandInput, type UpdateCartItemDto, type UpdateCategoryDto as UpdateCategoryInput, type UpdateContentInput, type UpdateCouponDto, type UpdateCustomApiDto, type UpdateCustomerDto, type UpdateDraftDto, type UpdateEmailSettingsDto as UpdateEmailSettingsInput, type UpdateEmailTemplateDto as UpdateEmailTemplateInput, type UpdateInventoryDto, type UpdateMemberRoleDto as UpdateMemberRoleInput, type UpdateMetafieldDefinitionDto as UpdateMetafieldDefinitionInput, type UpdateModifierGroupInput, type UpdateModifierInput, type UpdateOAuthProviderDto as UpdateOAuthProviderInput, type UpdateOrderDto, type UpdateOrderShippingDto, type UpdateProductDto, type UpdateShippingRateDto as UpdateShippingRateInput, type UpdateShippingZoneDto as UpdateShippingZoneInput, type UpdateStoreMemberDto as UpdateStoreMemberInput, type UpdateTagDto as UpdateTagInput, type UpdateTaxRateDto as UpdateTaxRateInput, type UpdateVariantDto, type UpdateVariantInventoryDto, type UpsertProductMetafieldDto as UpsertProductMetafieldInput, type UserStore, type UserStorePermissions, type VariantInventoryResponse, type VariantPlatformOverlay, type VariantStatus, type WaitForOrderOptions, type WaitForOrderResult, type WebhookEvent, type WebhookEventType, type WriteProductReviewInput, buildArticleJsonLd, buildBreadcrumbJsonLd, buildCollectionPageJsonLd, buildOrganizationJsonLd, buildProductJsonLd, buildWebsiteJsonLd, createWebhookHandler, deriveSeoDescription, enableDevGuards, formatMoney, formatPrice, formatProductPrice, formatVariantPrice, getBlogSitemapEntries, getCartItemImage, getCartItemName, getCartTotals, getCategorySitemapEntries, getDescriptionContent, getDirectionForLocale, formatPrice as getPriceDisplay, getProductCustomizationFields, getProductMetafield, getProductMetafieldValue, getProductMetafieldsByType, getProductPrice, getProductPriceInfo, getProductSwatches, getStockStatus, getVariantOptions, getVariantPrice, isAllowedPaymentUrl, isCouponApplicableToProduct, isHtmlDescription, isWebhookEventType, jsonLdScriptProps, parseWebhookEvent, safePaymentRedirect, stripHtml, verifyWebhook };