brainerce 1.10.3 → 1.11.3

package/README.md

@@ -4,7 +4,7 @@ Official SDK for building e-commerce storefronts with **Brainerce Platform**.
 
 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.
 
-> **🤖 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.
+> **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).
 
 ## Installation
 
@@ -1058,7 +1058,7 @@ interface Product {
   sku: string;
   basePrice: number;
   salePrice?: number | null;
-  status: 'active' | 'draft' | 'archived';
+  status: 'active' | 'draft';
   type: 'SIMPLE' | 'VARIABLE';
   images?: ProductImage[];
   inventory?: InventoryInfo | null;
@@ -2827,11 +2827,70 @@ const brand = await client.createBrand({ name: 'Nike', slug: 'nike' });
 const tags = await client.listTags();
 const tag = await client.createTag({ name: 'Sale', slug: 'sale' });
 
-// Attributes (for variant options)
+// Attributes (for variant options like Size, Color, Material)
 const attributes = await client.listAttributes();
-const attribute = await client.createAttribute({ name: 'Color', slug: 'color' });
-const options = await client.getAttributeOptions('attr_id');
-await client.createAttributeOption('attr_id', { value: 'Red', slug: 'red' });
+
+// Create a color swatch attribute
+const colorAttr = await client.createAttribute({
+  name: 'Color',
+  displayType: 'COLOR_SWATCH', // Options: 'DEFAULT' | 'COLOR_SWATCH' | 'IMAGE_SWATCH'
+  source: 'GLOBAL',
+});
+
+// Add color swatch options
+await client.createAttributeOption(colorAttr.id, {
+  name: 'Red',
+  value: 'red',
+  swatchColor: '#FF0000',
+  source: 'GLOBAL',
+});
+
+// Gradient swatch (two colors)
+await client.createAttributeOption(colorAttr.id, {
+  name: 'Sunset',
+  value: 'sunset',
+  swatchColor: '#FF6B35',
+  swatchColor2: '#FFD700',
+  source: 'GLOBAL',
+});
+
+// Image swatch attribute
+const materialAttr = await client.createAttribute({
+  name: 'Material',
+  displayType: 'IMAGE_SWATCH',
+  source: 'GLOBAL',
+});
+await client.createAttributeOption(materialAttr.id, {
+  name: 'Leather',
+  value: 'leather',
+  swatchImageUrl: 'https://example.com/leather-texture.jpg',
+  source: 'GLOBAL',
+});
+
+// Default attribute (text buttons/dropdown)
+const sizeAttr = await client.createAttribute({
+  name: 'Size',
+  source: 'GLOBAL',
+});
+await client.createAttributeOption(sizeAttr.id, {
+  name: 'Large',
+  value: 'L',
+  source: 'GLOBAL',
+});
+
+// Get options, update, delete
+const options = await client.getAttributeOptions(colorAttr.id);
+await client.updateAttribute(colorAttr.id, { displayType: 'IMAGE_SWATCH' });
+await client.updateAttributeOption(colorAttr.id, options[0].id, { swatchColor: '#CC0000' });
+await client.deleteAttributeOption(colorAttr.id, options[0].id);
+await client.deleteAttribute(colorAttr.id);
+
+// Storefront: render swatches from product data
+import { getProductSwatches } from 'brainerce';
+
+const product = await client.getProductBySlug('my-product');
+const swatches = getProductSwatches(product);
+// Returns: [{ attributeName: 'Color', displayType: 'COLOR_SWATCH', options: [{ name: 'Red', swatchColor: '#FF0000', ... }] }]
 ```
 
 ### Shipping Configuration

package/dist/index.d.mts

@@ -73,6 +73,22 @@ interface BrainerceClientOptions {
         statusCode: number;
         path?: string;
     }) => void;
+    /**
+     * Origin header to send with requests.
+     * Browsers add this automatically, but Node.js environments (SSR, scripts, npx)
+     * do not. When running server-side, the SDK will auto-derive it from `baseUrl`
+     * if not explicitly provided.
+     *
+     * @example
+     * ```typescript
+     * // Explicit origin for server-side usage
+     * const client = new BrainerceClient({
+     *   connectionId: 'vc_abc123...',
+     *   origin: 'https://mysite.com',
+     * });
+     * ```
+     */
+    origin?: string;
     /**
      * Enable proxy mode for BFF (Backend-for-Frontend) pattern.
      * When true, the SDK skips client-side customer token checks and does not
@@ -167,7 +183,7 @@ interface Product {
     salePrice?: string | null;
     /** Cost price as string. Use parseFloat() for calculations. */
     costPrice?: string | null;
-    /** Product status (active, draft, archived). Always returned by backend. */
+    /** Product status (active, draft). Always returned by backend. */
     status: string;
     type: 'SIMPLE' | 'VARIABLE';
     /** Whether product is downloadable/digital. */
@@ -202,6 +218,8 @@ interface Product {
     lastSyncedAt?: string | null;
     /** Menu/display order */
     menuOrder?: number | null;
+    /** Tax behavior: 'taxable' follows store setting, 'exempt' always skips tax */
+    taxBehavior?: 'taxable' | 'exempt';
     /** Full attribute options for variant selection (admin mode only) */
     productAttributeOptions?: Array<{
         id: string;
@@ -211,11 +229,15 @@ interface Product {
         attribute: {
             id: string;
             name: string;
+            displayType?: string;
         } | null;
         attributeOption: {
             id: string;
             name: string;
             value?: string | null;
+            swatchColor?: string | null;
+            swatchColor2?: string | null;
+            swatchImageUrl?: string | null;
         } | null;
     }>;
     /** Vibe-coded sites this product is published to (admin mode only) */
@@ -228,6 +250,8 @@ interface Product {
     }>;
     /** Discount info from matching discount rules (storefront/VC mode only) */
     discount?: ProductDiscount | null;
+    /** Recommendations (upsells, cross-sells, related) — included in storefront/VC getProductBySlug response */
+    recommendations?: ProductRecommendationsResponse;
     createdAt: string;
     updatedAt: string;
 }
@@ -620,6 +644,22 @@ declare function getVariantOptions(variant: Pick<ProductVariant, 'attributes'> |
     name: string;
     value: string;
 }>;
+/**
+ * Get structured swatch data from product attribute options.
+ * Groups by attribute name and includes display type + swatch details.
+ * Useful for rendering swatch selectors in storefronts.
+ */
+declare function getProductSwatches(product: Pick<Product, 'productAttributeOptions'> | null | undefined): Array<{
+    attributeName: string;
+    displayType: string;
+    options: Array<{
+        name: string;
+        value?: string | null;
+        swatchColor?: string | null;
+        swatchColor2?: string | null;
+        swatchImageUrl?: string | null;
+    }>;
+}>;
 /**
  * Get a single metafield by definition key.
  */
@@ -642,7 +682,7 @@ interface ProductQueryParams {
     page?: number;
     limit?: number;
     search?: string;
-    status?: 'active' | 'draft' | 'archived';
+    status?: 'active' | 'draft';
     /** Filter by category IDs (comma-separated or array) */
     categories?: string | string[];
     /** Filter by brand IDs (comma-separated or array) */
@@ -750,7 +790,7 @@ interface UpdateProductDto {
     basePrice?: number;
     salePrice?: number | null;
     costPrice?: number | null;
-    status?: 'active' | 'draft' | 'archived';
+    status?: 'active' | 'draft';
     isDownloadable?: boolean;
     categories?: string[];
     tags?: string[];
@@ -1267,6 +1307,7 @@ interface RegisterCustomerDto {
     firstName?: string;
     lastName?: string;
     phone?: string;
+    acceptsMarketing?: boolean;
 }
 type CartStatus = 'ACTIVE' | 'MERGED' | 'CONVERTED' | 'ABANDONED';
 /**
@@ -2691,6 +2732,8 @@ interface Category {
     platformMetadata?: Record<string, Record<string, unknown>> | null;
     parentId?: string | null;
     isActive: boolean;
+    /** Tax behavior: 'taxable' follows store setting, 'exempt' always skips tax */
+    taxBehavior?: 'taxable' | 'exempt';
     deletedAt?: string | null;
     productCount?: number;
     products?: Array<{
@@ -2707,11 +2750,13 @@ interface CreateCategoryDto {
     storeId?: string;
     source?: string;
     isActive?: boolean;
+    taxBehavior?: 'taxable' | 'exempt';
 }
 interface UpdateCategoryDto {
     name?: string;
     parentId?: string | null;
     isActive?: boolean;
+    taxBehavior?: 'taxable' | 'exempt';
 }
 /**
  * Brand entity for product organization
@@ -2801,6 +2846,7 @@ interface Attribute {
     accountId: string;
     storeId?: string | null;
     name: string;
+    displayType?: string;
     source: AttributeSource;
     platform?: ConnectorPlatform | null;
     externalId?: string | null;
@@ -2817,6 +2863,9 @@ interface AttributeOption {
     attributeId: string;
     name: string;
     value?: string | null;
+    swatchColor?: string | null;
+    swatchColor2?: string | null;
+    swatchImageUrl?: string | null;
     source: AttributeSource;
     platform?: ConnectorPlatform | null;
     externalId?: string | null;
@@ -2829,6 +2878,7 @@ interface AttributeOption {
 }
 interface CreateAttributeDto {
     name: string;
+    displayType?: string;
     source: AttributeSource;
     platform?: ConnectorPlatform;
     storeId?: string;
@@ -2838,12 +2888,16 @@ interface CreateAttributeDto {
 }
 interface UpdateAttributeDto {
     name?: string;
+    displayType?: string;
     platformMetadata?: Record<string, unknown>;
     isActive?: boolean;
 }
 interface CreateAttributeOptionDto {
     name: string;
     value?: string;
+    swatchColor?: string;
+    swatchColor2?: string;
+    swatchImageUrl?: string;
     source: AttributeSource;
     platform?: ConnectorPlatform;
     externalId?: string;
@@ -2854,6 +2908,9 @@ interface CreateAttributeOptionDto {
 interface UpdateAttributeOptionDto {
     name?: string;
     value?: string;
+    swatchColor?: string | null;
+    swatchColor2?: string | null;
+    swatchImageUrl?: string | null;
     platformMetadata?: Record<string, unknown>;
     position?: number;
     isActive?: boolean;
@@ -3541,6 +3598,7 @@ declare class BrainerceClient {
      * This is needed because Stripe redirects lose in-memory state.
      */
     private readonly ACTIVE_CHECKOUT_KEY;
+    private readonly origin?;
     private readonly proxyMode;
     private readonly onAuthError?;
     constructor(options: BrainerceClientOptions);
@@ -6469,6 +6527,8 @@ declare class BrainerceError extends Error {
     constructor(message: string, statusCode: number, details?: unknown);
 }
 
+declare const SDK_VERSION = "1.11.2";
+
 /**
  * Verify a webhook signature from Brainerce
  *
@@ -6541,4 +6601,4 @@ declare function enableDevGuards(options?: {
     force?: boolean;
 }): void;
 
-export { type AddToCartDto, type AppliedDiscount, type ApplyCouponDto, type Attribute, type AttributeOption, type AttributeSource, type BrainerceApiError, BrainerceClient, type BrainerceClientOptions, BrainerceError, type Brand, type BulkInventoryResponse, type BulkSaveVariantsDto, type BulkSaveVariantsResponse, type BulkVariantInput, type Cart, type CartAppliedDiscount, type CartItem, type CartNudge, type CartRecommendationsResponse, type CartStatus, type Category, type CategoryNode, type CategorySuggestion, type Checkout, type CheckoutAddress, type CheckoutLineItem, type CheckoutPrefillData, type CheckoutStatus, type CompleteCheckoutResponse, type CompleteDraftDto, type ConfigureOAuthProviderDto as ConfigureOAuthProviderInput, type ConflictStatus, type ConnectorPlatform, 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 CreateCouponDto, type CreateCustomApiDto, type CreateCustomerDto, type CreateEmailTemplateDto as CreateEmailTemplateInput, type CreateGuestOrderDto, type CreateMetafieldDefinitionDto as CreateMetafieldDefinitionInput, 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 EmailVerificationResponse, type ExtendReservationResponse, type FormatPriceOptions, type FulfillOrderDto, type GuestCheckoutStartResponse, type GuestOrderResponse, type InsufficientStockError, type InventoryInfo, type InventoryReservationStrategy, type InventorySyncStatus, type InventoryTrackingMode, type InvitationStatus, type InviteMemberDto as InviteMemberInput, type InviteStoreMemberDto as InviteStoreMemberInput, type LocalCart, type LocalCartItem, type MergeCartsDto, type MetafieldConflict, type MetafieldConflictResolution, type MetafieldDefinition, type MetafieldPlatformMapping, type MetafieldType, type OAuthAuthorizeResponse, type OAuthCallbackResponse, type OAuthConnection, type OAuthConnectionsResponse, type OAuthProviderConfig, type OAuthProviderType, type OAuthProvidersResponse, type Order, type OrderAddress, type OrderCustomer, type OrderDownloadLink, type OrderItem, type OrderQueryParams, type OrderStatus, type PaginatedResponse, type PaymentClientSdk, type PaymentConfig, type PaymentIntent, type PaymentProvider, type PaymentProviderConfig, type PaymentProvidersConfig, type PaymentStatus, type PickupLocation, type PlatformCouponCapabilities, type PreviewEmailTemplateDto as PreviewEmailTemplateInput, type Product, type ProductAttributeInput, type ProductAvailability, type ProductDiscount, type ProductDiscountBadge, type ProductImage, type ProductMetafield, type ProductMetafieldValue, type ProductQueryParams, type ProductRecommendation, type ProductRecommendationsResponse, type ProductRelationType, type ProductSuggestion, type ProductVariant, type PublicMetafieldDefinition, type PublishProductResponse, type ReconcileInventoryResponse, type Refund, type RefundLineItem, type RefundLineItemResponse, type RefundType, type RegisterCustomerDto, type ReservationInfo, type ResolveMetafieldConflictDto as ResolveMetafieldConflictInput, type ResolveSyncConflictDto as ResolveSyncConflictInput, type SearchSuggestions, type SelectPickupLocationDto, type SelectShippingMethodDto, type SendInvoiceDto, type SessionCartRef, type SetBillingAddressDto, type SetCheckoutCustomerDto, type SetShippingAddressDto, type SetShippingAddressResponse, type ShippingDestinations, type ShippingLine, type ShippingRate, type ShippingRateConfig, type ShippingRateType, type ShippingZone, type ShippingZoneQueryParams, type StockAvailabilityRequest, type StockAvailabilityResponse, type StockAvailabilityResult, type StoreInfo, type StoreInvitation, type StoreInvitationDetails, type StoreMember, type StorePermission, type StoreRole, type StoreTeamResponse, 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 UpdateAttributeDto as UpdateAttributeInput, type UpdateAttributeOptionDto as UpdateAttributeOptionInput, type UpdateBrandDto as UpdateBrandInput, type UpdateCartItemDto, type UpdateCategoryDto as UpdateCategoryInput, 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 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, createWebhookHandler, enableDevGuards, formatPrice, getCartItemImage, getCartItemName, getCartTotals, getDescriptionContent, formatPrice as getPriceDisplay, getProductMetafield, getProductMetafieldValue, getProductMetafieldsByType, getProductPrice, getProductPriceInfo, getStockStatus, getVariantOptions, getVariantPrice, isCouponApplicableToProduct, isHtmlDescription, isWebhookEventType, parseWebhookEvent, verifyWebhook };
+export { type AddToCartDto, type AppliedDiscount, type ApplyCouponDto, type Attribute, type AttributeOption, type AttributeSource, type BrainerceApiError, BrainerceClient, type BrainerceClientOptions, BrainerceError, type Brand, type BulkInventoryResponse, type BulkSaveVariantsDto, type BulkSaveVariantsResponse, type BulkVariantInput, type Cart, type CartAppliedDiscount, type CartItem, type CartNudge, type CartRecommendationsResponse, type CartStatus, type Category, type CategoryNode, type CategorySuggestion, type Checkout, type CheckoutAddress, type CheckoutLineItem, type CheckoutPrefillData, type CheckoutStatus, type CompleteCheckoutResponse, type CompleteDraftDto, type ConfigureOAuthProviderDto as ConfigureOAuthProviderInput, type ConflictStatus, type ConnectorPlatform, 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 CreateCouponDto, type CreateCustomApiDto, type CreateCustomerDto, type CreateEmailTemplateDto as CreateEmailTemplateInput, type CreateGuestOrderDto, type CreateMetafieldDefinitionDto as CreateMetafieldDefinitionInput, 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 EmailVerificationResponse, type ExtendReservationResponse, type FormatPriceOptions, type FulfillOrderDto, type GuestCheckoutStartResponse, type GuestOrderResponse, type InsufficientStockError, type InventoryInfo, type InventoryReservationStrategy, type InventorySyncStatus, type InventoryTrackingMode, type InvitationStatus, type InviteMemberDto as InviteMemberInput, type InviteStoreMemberDto as InviteStoreMemberInput, type LocalCart, type LocalCartItem, type MergeCartsDto, type MetafieldConflict, type MetafieldConflictResolution, type MetafieldDefinition, type MetafieldPlatformMapping, type MetafieldType, type OAuthAuthorizeResponse, type OAuthCallbackResponse, type OAuthConnection, type OAuthConnectionsResponse, type OAuthProviderConfig, type OAuthProviderType, type OAuthProvidersResponse, type Order, type OrderAddress, type OrderCustomer, type OrderDownloadLink, type OrderItem, type OrderQueryParams, type OrderStatus, type PaginatedResponse, type PaymentClientSdk, type PaymentConfig, type PaymentIntent, type PaymentProvider, type PaymentProviderConfig, type PaymentProvidersConfig, type PaymentStatus, type PickupLocation, type PlatformCouponCapabilities, type PreviewEmailTemplateDto as PreviewEmailTemplateInput, type Product, type ProductAttributeInput, type ProductAvailability, type ProductDiscount, type ProductDiscountBadge, type ProductImage, type ProductMetafield, type ProductMetafieldValue, type ProductQueryParams, type ProductRecommendation, type ProductRecommendationsResponse, type ProductRelationType, type ProductSuggestion, type ProductVariant, type PublicMetafieldDefinition, type PublishProductResponse, type ReconcileInventoryResponse, type Refund, type RefundLineItem, type RefundLineItemResponse, type RefundType, type RegisterCustomerDto, type ReservationInfo, type ResolveMetafieldConflictDto as ResolveMetafieldConflictInput, type ResolveSyncConflictDto as ResolveSyncConflictInput, SDK_VERSION, type SearchSuggestions, type SelectPickupLocationDto, type SelectShippingMethodDto, type SendInvoiceDto, type SessionCartRef, type SetBillingAddressDto, type SetCheckoutCustomerDto, type SetShippingAddressDto, type SetShippingAddressResponse, type ShippingDestinations, type ShippingLine, type ShippingRate, type ShippingRateConfig, type ShippingRateType, type ShippingZone, type ShippingZoneQueryParams, type StockAvailabilityRequest, type StockAvailabilityResponse, type StockAvailabilityResult, type StoreInfo, type StoreInvitation, type StoreInvitationDetails, type StoreMember, type StorePermission, type StoreRole, type StoreTeamResponse, 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 UpdateAttributeDto as UpdateAttributeInput, type UpdateAttributeOptionDto as UpdateAttributeOptionInput, type UpdateBrandDto as UpdateBrandInput, type UpdateCartItemDto, type UpdateCategoryDto as UpdateCategoryInput, 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 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, createWebhookHandler, enableDevGuards, formatPrice, getCartItemImage, getCartItemName, getCartTotals, getDescriptionContent, formatPrice as getPriceDisplay, getProductMetafield, getProductMetafieldValue, getProductMetafieldsByType, getProductPrice, getProductPriceInfo, getProductSwatches, getStockStatus, getVariantOptions, getVariantPrice, isCouponApplicableToProduct, isHtmlDescription, isWebhookEventType, parseWebhookEvent, verifyWebhook };

package/dist/index.d.ts

@@ -73,6 +73,22 @@ interface BrainerceClientOptions {
         statusCode: number;
         path?: string;
     }) => void;
+    /**
+     * Origin header to send with requests.
+     * Browsers add this automatically, but Node.js environments (SSR, scripts, npx)
+     * do not. When running server-side, the SDK will auto-derive it from `baseUrl`
+     * if not explicitly provided.
+     *
+     * @example
+     * ```typescript
+     * // Explicit origin for server-side usage
+     * const client = new BrainerceClient({
+     *   connectionId: 'vc_abc123...',
+     *   origin: 'https://mysite.com',
+     * });
+     * ```
+     */
+    origin?: string;
     /**
      * Enable proxy mode for BFF (Backend-for-Frontend) pattern.
      * When true, the SDK skips client-side customer token checks and does not
@@ -167,7 +183,7 @@ interface Product {
     salePrice?: string | null;
     /** Cost price as string. Use parseFloat() for calculations. */
     costPrice?: string | null;
-    /** Product status (active, draft, archived). Always returned by backend. */
+    /** Product status (active, draft). Always returned by backend. */
     status: string;
     type: 'SIMPLE' | 'VARIABLE';
     /** Whether product is downloadable/digital. */
@@ -202,6 +218,8 @@ interface Product {
     lastSyncedAt?: string | null;
     /** Menu/display order */
     menuOrder?: number | null;
+    /** Tax behavior: 'taxable' follows store setting, 'exempt' always skips tax */
+    taxBehavior?: 'taxable' | 'exempt';
     /** Full attribute options for variant selection (admin mode only) */
     productAttributeOptions?: Array<{
         id: string;
@@ -211,11 +229,15 @@ interface Product {
         attribute: {
             id: string;
             name: string;
+            displayType?: string;
         } | null;
         attributeOption: {
             id: string;
             name: string;
             value?: string | null;
+            swatchColor?: string | null;
+            swatchColor2?: string | null;
+            swatchImageUrl?: string | null;
         } | null;
     }>;
     /** Vibe-coded sites this product is published to (admin mode only) */
@@ -228,6 +250,8 @@ interface Product {
     }>;
     /** Discount info from matching discount rules (storefront/VC mode only) */
     discount?: ProductDiscount | null;
+    /** Recommendations (upsells, cross-sells, related) — included in storefront/VC getProductBySlug response */
+    recommendations?: ProductRecommendationsResponse;
     createdAt: string;
     updatedAt: string;
 }
@@ -620,6 +644,22 @@ declare function getVariantOptions(variant: Pick<ProductVariant, 'attributes'> |
     name: string;
     value: string;
 }>;
+/**
+ * Get structured swatch data from product attribute options.
+ * Groups by attribute name and includes display type + swatch details.
+ * Useful for rendering swatch selectors in storefronts.
+ */
+declare function getProductSwatches(product: Pick<Product, 'productAttributeOptions'> | null | undefined): Array<{
+    attributeName: string;
+    displayType: string;
+    options: Array<{
+        name: string;
+        value?: string | null;
+        swatchColor?: string | null;
+        swatchColor2?: string | null;
+        swatchImageUrl?: string | null;
+    }>;
+}>;
 /**
  * Get a single metafield by definition key.
  */
@@ -642,7 +682,7 @@ interface ProductQueryParams {
     page?: number;
     limit?: number;
     search?: string;
-    status?: 'active' | 'draft' | 'archived';
+    status?: 'active' | 'draft';
     /** Filter by category IDs (comma-separated or array) */
     categories?: string | string[];
     /** Filter by brand IDs (comma-separated or array) */
@@ -750,7 +790,7 @@ interface UpdateProductDto {
     basePrice?: number;
     salePrice?: number | null;
     costPrice?: number | null;
-    status?: 'active' | 'draft' | 'archived';
+    status?: 'active' | 'draft';
     isDownloadable?: boolean;
     categories?: string[];
     tags?: string[];
@@ -1267,6 +1307,7 @@ interface RegisterCustomerDto {
     firstName?: string;
     lastName?: string;
     phone?: string;
+    acceptsMarketing?: boolean;
 }
 type CartStatus = 'ACTIVE' | 'MERGED' | 'CONVERTED' | 'ABANDONED';
 /**
@@ -2691,6 +2732,8 @@ interface Category {
     platformMetadata?: Record<string, Record<string, unknown>> | null;
     parentId?: string | null;
     isActive: boolean;
+    /** Tax behavior: 'taxable' follows store setting, 'exempt' always skips tax */
+    taxBehavior?: 'taxable' | 'exempt';
     deletedAt?: string | null;
     productCount?: number;
     products?: Array<{
@@ -2707,11 +2750,13 @@ interface CreateCategoryDto {
     storeId?: string;
     source?: string;
     isActive?: boolean;
+    taxBehavior?: 'taxable' | 'exempt';
 }
 interface UpdateCategoryDto {
     name?: string;
     parentId?: string | null;
     isActive?: boolean;
+    taxBehavior?: 'taxable' | 'exempt';
 }
 /**
  * Brand entity for product organization
@@ -2801,6 +2846,7 @@ interface Attribute {
     accountId: string;
     storeId?: string | null;
     name: string;
+    displayType?: string;
     source: AttributeSource;
     platform?: ConnectorPlatform | null;
     externalId?: string | null;
@@ -2817,6 +2863,9 @@ interface AttributeOption {
     attributeId: string;
     name: string;
     value?: string | null;
+    swatchColor?: string | null;
+    swatchColor2?: string | null;
+    swatchImageUrl?: string | null;
     source: AttributeSource;
     platform?: ConnectorPlatform | null;
     externalId?: string | null;
@@ -2829,6 +2878,7 @@ interface AttributeOption {
 }
 interface CreateAttributeDto {
     name: string;
+    displayType?: string;
     source: AttributeSource;
     platform?: ConnectorPlatform;
     storeId?: string;
@@ -2838,12 +2888,16 @@ interface CreateAttributeDto {
 }
 interface UpdateAttributeDto {
     name?: string;
+    displayType?: string;
     platformMetadata?: Record<string, unknown>;
     isActive?: boolean;
 }
 interface CreateAttributeOptionDto {
     name: string;
     value?: string;
+    swatchColor?: string;
+    swatchColor2?: string;
+    swatchImageUrl?: string;
     source: AttributeSource;
     platform?: ConnectorPlatform;
     externalId?: string;
@@ -2854,6 +2908,9 @@ interface CreateAttributeOptionDto {
 interface UpdateAttributeOptionDto {
     name?: string;
     value?: string;
+    swatchColor?: string | null;
+    swatchColor2?: string | null;
+    swatchImageUrl?: string | null;
     platformMetadata?: Record<string, unknown>;
     position?: number;
     isActive?: boolean;
@@ -3541,6 +3598,7 @@ declare class BrainerceClient {
      * This is needed because Stripe redirects lose in-memory state.
      */
     private readonly ACTIVE_CHECKOUT_KEY;
+    private readonly origin?;
     private readonly proxyMode;
     private readonly onAuthError?;
     constructor(options: BrainerceClientOptions);
@@ -6469,6 +6527,8 @@ declare class BrainerceError extends Error {
     constructor(message: string, statusCode: number, details?: unknown);
 }
 
+declare const SDK_VERSION = "1.11.2";
+
 /**
  * Verify a webhook signature from Brainerce
  *
@@ -6541,4 +6601,4 @@ declare function enableDevGuards(options?: {
     force?: boolean;
 }): void;
 
-export { type AddToCartDto, type AppliedDiscount, type ApplyCouponDto, type Attribute, type AttributeOption, type AttributeSource, type BrainerceApiError, BrainerceClient, type BrainerceClientOptions, BrainerceError, type Brand, type BulkInventoryResponse, type BulkSaveVariantsDto, type BulkSaveVariantsResponse, type BulkVariantInput, type Cart, type CartAppliedDiscount, type CartItem, type CartNudge, type CartRecommendationsResponse, type CartStatus, type Category, type CategoryNode, type CategorySuggestion, type Checkout, type CheckoutAddress, type CheckoutLineItem, type CheckoutPrefillData, type CheckoutStatus, type CompleteCheckoutResponse, type CompleteDraftDto, type ConfigureOAuthProviderDto as ConfigureOAuthProviderInput, type ConflictStatus, type ConnectorPlatform, 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 CreateCouponDto, type CreateCustomApiDto, type CreateCustomerDto, type CreateEmailTemplateDto as CreateEmailTemplateInput, type CreateGuestOrderDto, type CreateMetafieldDefinitionDto as CreateMetafieldDefinitionInput, 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 EmailVerificationResponse, type ExtendReservationResponse, type FormatPriceOptions, type FulfillOrderDto, type GuestCheckoutStartResponse, type GuestOrderResponse, type InsufficientStockError, type InventoryInfo, type InventoryReservationStrategy, type InventorySyncStatus, type InventoryTrackingMode, type InvitationStatus, type InviteMemberDto as InviteMemberInput, type InviteStoreMemberDto as InviteStoreMemberInput, type LocalCart, type LocalCartItem, type MergeCartsDto, type MetafieldConflict, type MetafieldConflictResolution, type MetafieldDefinition, type MetafieldPlatformMapping, type MetafieldType, type OAuthAuthorizeResponse, type OAuthCallbackResponse, type OAuthConnection, type OAuthConnectionsResponse, type OAuthProviderConfig, type OAuthProviderType, type OAuthProvidersResponse, type Order, type OrderAddress, type OrderCustomer, type OrderDownloadLink, type OrderItem, type OrderQueryParams, type OrderStatus, type PaginatedResponse, type PaymentClientSdk, type PaymentConfig, type PaymentIntent, type PaymentProvider, type PaymentProviderConfig, type PaymentProvidersConfig, type PaymentStatus, type PickupLocation, type PlatformCouponCapabilities, type PreviewEmailTemplateDto as PreviewEmailTemplateInput, type Product, type ProductAttributeInput, type ProductAvailability, type ProductDiscount, type ProductDiscountBadge, type ProductImage, type ProductMetafield, type ProductMetafieldValue, type ProductQueryParams, type ProductRecommendation, type ProductRecommendationsResponse, type ProductRelationType, type ProductSuggestion, type ProductVariant, type PublicMetafieldDefinition, type PublishProductResponse, type ReconcileInventoryResponse, type Refund, type RefundLineItem, type RefundLineItemResponse, type RefundType, type RegisterCustomerDto, type ReservationInfo, type ResolveMetafieldConflictDto as ResolveMetafieldConflictInput, type ResolveSyncConflictDto as ResolveSyncConflictInput, type SearchSuggestions, type SelectPickupLocationDto, type SelectShippingMethodDto, type SendInvoiceDto, type SessionCartRef, type SetBillingAddressDto, type SetCheckoutCustomerDto, type SetShippingAddressDto, type SetShippingAddressResponse, type ShippingDestinations, type ShippingLine, type ShippingRate, type ShippingRateConfig, type ShippingRateType, type ShippingZone, type ShippingZoneQueryParams, type StockAvailabilityRequest, type StockAvailabilityResponse, type StockAvailabilityResult, type StoreInfo, type StoreInvitation, type StoreInvitationDetails, type StoreMember, type StorePermission, type StoreRole, type StoreTeamResponse, 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 UpdateAttributeDto as UpdateAttributeInput, type UpdateAttributeOptionDto as UpdateAttributeOptionInput, type UpdateBrandDto as UpdateBrandInput, type UpdateCartItemDto, type UpdateCategoryDto as UpdateCategoryInput, 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 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, createWebhookHandler, enableDevGuards, formatPrice, getCartItemImage, getCartItemName, getCartTotals, getDescriptionContent, formatPrice as getPriceDisplay, getProductMetafield, getProductMetafieldValue, getProductMetafieldsByType, getProductPrice, getProductPriceInfo, getStockStatus, getVariantOptions, getVariantPrice, isCouponApplicableToProduct, isHtmlDescription, isWebhookEventType, parseWebhookEvent, verifyWebhook };
+export { type AddToCartDto, type AppliedDiscount, type ApplyCouponDto, type Attribute, type AttributeOption, type AttributeSource, type BrainerceApiError, BrainerceClient, type BrainerceClientOptions, BrainerceError, type Brand, type BulkInventoryResponse, type BulkSaveVariantsDto, type BulkSaveVariantsResponse, type BulkVariantInput, type Cart, type CartAppliedDiscount, type CartItem, type CartNudge, type CartRecommendationsResponse, type CartStatus, type Category, type CategoryNode, type CategorySuggestion, type Checkout, type CheckoutAddress, type CheckoutLineItem, type CheckoutPrefillData, type CheckoutStatus, type CompleteCheckoutResponse, type CompleteDraftDto, type ConfigureOAuthProviderDto as ConfigureOAuthProviderInput, type ConflictStatus, type ConnectorPlatform, 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 CreateCouponDto, type CreateCustomApiDto, type CreateCustomerDto, type CreateEmailTemplateDto as CreateEmailTemplateInput, type CreateGuestOrderDto, type CreateMetafieldDefinitionDto as CreateMetafieldDefinitionInput, 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 EmailVerificationResponse, type ExtendReservationResponse, type FormatPriceOptions, type FulfillOrderDto, type GuestCheckoutStartResponse, type GuestOrderResponse, type InsufficientStockError, type InventoryInfo, type InventoryReservationStrategy, type InventorySyncStatus, type InventoryTrackingMode, type InvitationStatus, type InviteMemberDto as InviteMemberInput, type InviteStoreMemberDto as InviteStoreMemberInput, type LocalCart, type LocalCartItem, type MergeCartsDto, type MetafieldConflict, type MetafieldConflictResolution, type MetafieldDefinition, type MetafieldPlatformMapping, type MetafieldType, type OAuthAuthorizeResponse, type OAuthCallbackResponse, type OAuthConnection, type OAuthConnectionsResponse, type OAuthProviderConfig, type OAuthProviderType, type OAuthProvidersResponse, type Order, type OrderAddress, type OrderCustomer, type OrderDownloadLink, type OrderItem, type OrderQueryParams, type OrderStatus, type PaginatedResponse, type PaymentClientSdk, type PaymentConfig, type PaymentIntent, type PaymentProvider, type PaymentProviderConfig, type PaymentProvidersConfig, type PaymentStatus, type PickupLocation, type PlatformCouponCapabilities, type PreviewEmailTemplateDto as PreviewEmailTemplateInput, type Product, type ProductAttributeInput, type ProductAvailability, type ProductDiscount, type ProductDiscountBadge, type ProductImage, type ProductMetafield, type ProductMetafieldValue, type ProductQueryParams, type ProductRecommendation, type ProductRecommendationsResponse, type ProductRelationType, type ProductSuggestion, type ProductVariant, type PublicMetafieldDefinition, type PublishProductResponse, type ReconcileInventoryResponse, type Refund, type RefundLineItem, type RefundLineItemResponse, type RefundType, type RegisterCustomerDto, type ReservationInfo, type ResolveMetafieldConflictDto as ResolveMetafieldConflictInput, type ResolveSyncConflictDto as ResolveSyncConflictInput, SDK_VERSION, type SearchSuggestions, type SelectPickupLocationDto, type SelectShippingMethodDto, type SendInvoiceDto, type SessionCartRef, type SetBillingAddressDto, type SetCheckoutCustomerDto, type SetShippingAddressDto, type SetShippingAddressResponse, type ShippingDestinations, type ShippingLine, type ShippingRate, type ShippingRateConfig, type ShippingRateType, type ShippingZone, type ShippingZoneQueryParams, type StockAvailabilityRequest, type StockAvailabilityResponse, type StockAvailabilityResult, type StoreInfo, type StoreInvitation, type StoreInvitationDetails, type StoreMember, type StorePermission, type StoreRole, type StoreTeamResponse, 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 UpdateAttributeDto as UpdateAttributeInput, type UpdateAttributeOptionDto as UpdateAttributeOptionInput, type UpdateBrandDto as UpdateBrandInput, type UpdateCartItemDto, type UpdateCategoryDto as UpdateCategoryInput, 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 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, createWebhookHandler, enableDevGuards, formatPrice, getCartItemImage, getCartItemName, getCartTotals, getDescriptionContent, formatPrice as getPriceDisplay, getProductMetafield, getProductMetafieldValue, getProductMetafieldsByType, getProductPrice, getProductPriceInfo, getProductSwatches, getStockStatus, getVariantOptions, getVariantPrice, isCouponApplicableToProduct, isHtmlDescription, isWebhookEventType, parseWebhookEvent, verifyWebhook };