npm - brainerce - Versions diffs - 1.17.0 → 1.19.0 - Mend

brainerce 1.17.0 → 1.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/dist/index.d.ts CHANGED Viewed

@@ -895,6 +895,32 @@ interface Order {
     /** Tax amount */
     taxAmount?: string | null;
     createdAt: string;
+    /** Payment method used (e.g., "card", "paypal", "cash_on_delivery"). */
+    paymentMethod?: string | null;
+    /** Financial status: "pending", "paid", "refunded", "partially_refunded", "voided". */
+    financialStatus?: string | null;
+    /** Fulfillment status: "unfulfilled", "partial", "fulfilled". */
+    fulfillmentStatus?: string | null;
+    /** Tracking number, e.g., "1Z999AA10123456784". */
+    trackingNumber?: string | null;
+    /** Deep link to the carrier's tracking page. */
+    trackingUrl?: string | null;
+    /** Carrier name, e.g., "UPS", "USPS", "DHL". */
+    carrier?: string | null;
+    /** ISO-8601 timestamp when the order was shipped. */
+    shippedAt?: string | null;
+    /** ISO-8601 timestamp when the order was delivered. */
+    deliveredAt?: string | null;
+    /** Status timeline entries in chronological order. */
+    statusHistory?: OrderStatusChange[] | null;
+}
+/** One status transition on an order. */
+interface OrderStatusChange {
+    status: OrderStatus;
+    /** ISO-8601 timestamp of the transition. */
+    at: string;
+    /** Optional note (why the status changed). */
+    note?: string | null;
 }
 /**
  * Order status values are **lowercase**.
@@ -961,10 +987,13 @@ interface OrderItem {
     totalPrice?: string;
     /** Product image URL (flat, not nested under product object) */
     image?: string;
-    /** Customer input field values captured at checkout (e.g., cake text, uploaded logo) */
+    /**
+     * Customer input field values captured at checkout (e.g., cake text, uploaded logo).
+     * `value` is `string[]` for MULTI_SELECT / GALLERY types, `string` otherwise.
+     */
     customizations?: Record<string, {
         label: string;
-        value: string;
+        value: string | string[];
         type: string;
     }>;
 }
@@ -2498,8 +2527,8 @@ interface CustomApiTestResult {
  * The frontend dynamically loads the SDK script and calls init/render methods.
  */
 interface PaymentClientSdk {
-    /** How the payment UI is rendered: 'sdk-widget' (JS SDK), 'iframe', 'redirect', or 'sandbox' (test orders) */
-    renderType: 'sdk-widget' | 'iframe' | 'redirect' | 'sandbox';
+    /** How the payment UI is rendered: 'sdk-widget' (JS SDK), 'iframe', 'redirect', 'sandbox' (test orders), or 'embedded-fields' (PCI-compliant provider-hosted fields embedded in merchant DOM, e.g. Cardcom OpenFields, Stripe Elements) */
+    renderType: 'sdk-widget' | 'iframe' | 'redirect' | 'sandbox' | 'embedded-fields';
     /** URL of the main SDK script to load */
     scriptUrl?: string;
     /** Name of the global variable set by the SDK script (e.g., 'growPayment') */
@@ -2521,6 +2550,12 @@ interface PaymentClientSdk {
     }>;
     /** CSS to inject into <head> when SDK is active (e.g., LTR overrides for body-level popups on RTL pages) */
     bodyStyles?: string;
+    /** For renderType='embedded-fields': base URL the sensitive-field iframes load (e.g. 'https://secure.cardcom.solutions'). postMessage origin is strictly validated against this. */
+    embeddedFieldsUrl?: string;
+    /** For renderType='embedded-fields': opaque provider session id used in the iframe init handshake (e.g., Cardcom LowProfileId) */
+    embeddedFieldsSessionId?: string;
+    /** Provider discriminator that selects the correct embedded-fields component on the storefront */
+    embeddedFieldsProvider?: 'cardcom';
 }
 /**
  * Payment provider configuration (returned by `getPaymentProviders()`).
@@ -3156,7 +3191,7 @@ interface UpdateTaxRateDto {
 /**
  * Metafield type for defining value structure
  */
-type MetafieldType = 'TEXT' | 'TEXTAREA' | 'NUMBER' | 'BOOLEAN' | 'DATE' | 'DATETIME' | 'URL' | 'COLOR' | 'DIMENSION' | 'WEIGHT' | 'JSON' | 'IMAGE' | 'GALLERY';
+type MetafieldType = 'TEXT' | 'TEXTAREA' | 'NUMBER' | 'BOOLEAN' | 'DATE' | 'DATETIME' | 'URL' | 'COLOR' | 'DIMENSION' | 'WEIGHT' | 'JSON' | 'IMAGE' | 'GALLERY' | 'SELECT' | 'MULTI_SELECT';
 /**
  * Metafield definition - schema for product metafields
  */
@@ -3168,6 +3203,13 @@ interface MetafieldDefinition {
     description?: string | null;
     type: MetafieldType;
     required: boolean;
+    isCustomerInput?: boolean;
+    /**
+     * When `true`, the field is treated as present on every product of this
+     * account — including products created later. Clients don't need to list
+     * individual `ProductCustomizationField` rows when this is set.
+     */
+    appliesToAllProducts?: boolean;
     minLength?: number | null;
     maxLength?: number | null;
     minValue?: number | null;
@@ -3177,6 +3219,11 @@ interface MetafieldDefinition {
     position: number;
     isActive: boolean;
     mappings?: MetafieldPlatformMapping[];
+    /** Products this definition is explicitly attached to (customer-input only). */
+    products?: Array<{
+        id: string;
+        name: string;
+    }>;
     createdAt: string;
     updatedAt: string;
 }
@@ -3192,6 +3239,11 @@ interface PublicMetafieldDefinition {
     type: MetafieldType;
     required: boolean;
     isCustomerInput?: boolean;
+    /**
+     * When true, this definition applies to every product of the account —
+     * including ones created after the flag was set.
+     */
+    appliesToAllProducts?: boolean;
     enumValues?: string[];
     minLength?: number | null;
     maxLength?: number | null;
@@ -3238,6 +3290,14 @@ interface CreateMetafieldDefinitionDto {
     description?: string;
     type?: MetafieldType;
     required?: boolean;
+    isCustomerInput?: boolean;
+    /** When true the field applies to every product in the account. */
+    appliesToAllProducts?: boolean;
+    /**
+     * Assign the new (customer-input) definition to specific products atomically
+     * in the same create call. Only valid when `isCustomerInput` is true.
+     */
+    productIds?: string[];
     minLength?: number;
     maxLength?: number;
     minValue?: number;
@@ -3251,6 +3311,8 @@ interface UpdateMetafieldDefinitionDto {
     description?: string | null;
     type?: MetafieldType;
     required?: boolean;
+    isCustomerInput?: boolean;
+    appliesToAllProducts?: boolean;
     minLength?: number | null;
     maxLength?: number | null;
     minValue?: number | null;
@@ -3260,6 +3322,16 @@ interface UpdateMetafieldDefinitionDto {
     position?: number;
     isActive?: boolean;
 }
+/**
+ * Set (replace with diff-scoped semantics) the list of products linked to a
+ * single customer-input metafield definition. Passing an empty array detaches
+ * the definition from every product.
+ */
+interface SetDefinitionProductsDto {
+    productIds: string[];
+    /** Optionally flip the `appliesToAllProducts` flag in the same call. */
+    appliesToAllProducts?: boolean;
+}
 /**
  * Product metafield value
  */
@@ -3693,6 +3765,21 @@ interface CartBundleOffer {
 interface CartBundlesResponse {
     bundles: CartBundleOffer[];
 }
+/** Valid values for the cart `include` query parameter */
+type CartIncludeOption = 'recommendations' | 'upgrades' | 'bundles';
+/** Options for getCart / smartGetCart with optional includes */
+interface CartIncludeOptions {
+    include?: CartIncludeOption[];
+}
+/** Cart response enriched with optional included data */
+interface CartWithIncludes extends Cart {
+    /** Cross-sell recommendations (present when include contains 'recommendations') */
+    recommendations?: CartRecommendationsResponse;
+    /** Upgrade suggestions (present when include contains 'upgrades') */
+    upgrades?: CartUpgradesResponse;
+    /** Bundle offers (present when include contains 'bundles') */
+    bundles?: CartBundlesResponse;
+}
 interface OrderBump {
     id: string;
     title: string;
@@ -4911,18 +4998,60 @@ declare class BrainerceClient {
     getCartByCustomer(customerId: string): Promise<Cart>;
     /**
      * Get a cart by ID
+     *
+     * @param cartId - The cart ID
+     * @param options - Optional settings. Use `include` to fetch related data in a single request.
+     *
+     * @example
+     * ```typescript
+     * // Basic cart fetch
+     * const cart = await client.getCart('cart_123');
+     *
+     * // Fetch cart with recommendations, upgrades, and bundles in one call
+     * const enriched = await client.getCart('cart_123', {
+     *   include: ['recommendations', 'upgrades', 'bundles'],
+     * });
+     * console.log(enriched.recommendations); // { recommendations: [...] }
+     * console.log(enriched.upgrades);        // { upgrades: { ... } }
+     * console.log(enriched.bundles);         // { bundles: [...] }
+     * ```
      */
-    getCart(cartId: string): Promise<Cart>;
+    getCart(cartId: string, options?: CartIncludeOptions): Promise<CartWithIncludes>;
     /**
-     * Add an item to the cart
+     * Add an item to the cart.
+     *
+     * If the product has `customizationFields` (merchant-defined buyer input
+     * like engraving text, uploaded photos, select options), pass the buyer's
+     * values in `metadata`. Keys must match each field's `key`. For `IMAGE` /
+     * `GALLERY` types, upload the file first via `uploadCustomizationFile()`
+     * and pass the returned URL. The server validates every value against its
+     * `MetafieldDefinition` and rejects the request with HTTP 400 if anything
+     * fails (type mismatch, required missing, not in `enumValues`, etc.).
+     *
+     * Values are snapshotted onto the order line at checkout — later edits to
+     * the field definition do not retroactively change existing orders.
      *
      * @example
      * ```typescript
+     * // Product with no customization fields
      * const cart = await client.addToCart('cart_123', {
      *   productId: 'prod_abc',
      *   quantity: 2,
      *   notes: 'Gift wrap please',
      * });
+     *
+     * // Product WITH customization fields (engraving + photo + select + multi)
+     * const { url: photoUrl } = await client.uploadCustomizationFile(file);
+     * const cart = await client.addToCart('cart_123', {
+     *   productId: 'prod_mug',
+     *   quantity: 1,
+     *   metadata: {
+     *     engraving_text: 'Happy Birthday!',  // TEXT
+     *     frame_color: 'Gold',                // SELECT (must be in enumValues)
+     *     upload_photo: photoUrl,             // IMAGE
+     *     addons: ['Gift wrap'],              // MULTI_SELECT (always array)
+     *   },
+     * });
      * ```
      */
     addToCart(cartId: string, item: AddToCartDto): Promise<Cart>;
@@ -5263,6 +5392,7 @@ declare class BrainerceClient {
         productId: string;
         variantId?: string;
         quantity: number;
+        metadata?: Record<string, unknown>;
     }): Promise<Cart>;
     /**
      * Smart get cart - returns the current cart (server-side for both guests and logged-in users)
@@ -5271,13 +5401,21 @@ declare class BrainerceClient {
      * - **Guest with session**: Returns server-side session cart
      * - **Guest without session**: Returns empty cart (no server call, cart created lazily on add)
      *
+     * @param options - Optional. Use `include` to fetch recommendations, upgrades, and bundles
+     *   in a single request instead of separate calls.
+     *
      * @example
      * ```typescript
      * const cart = await client.smartGetCart();
      * console.log('Items:', cart.items.length);
+     *
+     * // With includes — single request for cart + extras
+     * const enriched = await client.smartGetCart({
+     *   include: ['recommendations', 'upgrades', 'bundles'],
+     * });
      * ```
      */
-    smartGetCart(): Promise<Cart>;
+    smartGetCart(options?: CartIncludeOptions): Promise<CartWithIncludes>;
     /**
      * Smart update cart item quantity
      *
@@ -6636,6 +6774,26 @@ declare class BrainerceClient {
      * Requires Admin mode (apiKey)
      */
     deleteMetafieldDefinition(definitionId: string): Promise<void>;
+    /**
+     * Replace the list of products a (customer-input) metafield definition is
+     * attached to. Diff-scoped: only rows for this definition are touched, so
+     * concurrent edits to other definitions on the same product are safe.
+     *
+     * Optionally toggles `appliesToAllProducts` in the same call. When that
+     * flag is true the `productIds` list is still respected as the explicit
+     * subset, but buyers will see the field on every product regardless.
+     *
+     * Requires Admin mode (apiKey).
+     *
+     * @example
+     * ```typescript
+     * await client.setDefinitionProducts('def_123', {
+     *   productIds: ['prod_a', 'prod_b'],
+     *   appliesToAllProducts: false,
+     * });
+     * ```
+     */
+    setDefinitionProducts(definitionId: string, data: SetDefinitionProductsDto): Promise<MetafieldDefinition>;
     /**
      * Get all metafield values for a product
      * Requires Admin mode (apiKey)
@@ -6670,9 +6828,35 @@ declare class BrainerceClient {
      */
     setProductCustomizationFields(productId: string, definitionIds: string[]): Promise<ProductCustomizationField[]>;
     /**
-     * Upload a file for product customization (e.g., customer logo for printing).
-     * Available in storefront and vibe-coded modes.
-     * Returns the uploaded file URL and key.
+     * Upload a buyer-submitted file (engraving photo, custom image, etc.) for a
+     * product customization field of type `IMAGE` or `GALLERY`. The returned `url`
+     * is what you pass back in the add-to-cart `metadata` payload.
+     *
+     * Available in storefront and vibe-coded modes — no customer login required.
+     *
+     * Server rules:
+     * - `image/*` MIME only. Other types → HTTP 400.
+     * - Max 5 MB per file.
+     * - Throttled to 10 uploads / minute per IP → HTTP 429.
+     * - Retention: at least 7 days. If the cart never becomes an order, the file
+     *   is reclaimed automatically. Once the order exists, the file is kept for
+     *   order-history purposes.
+     *
+     * @example
+     * ```ts
+     * // On a product page with IMAGE/GALLERY customization fields:
+     * const { url } = await client.uploadCustomizationFile(fileInput.files[0]);
+     *
+     * // Then include the URL in the add-to-cart metadata:
+     * await client.addToCart(cart.id, {
+     *   productId: product.id,
+     *   quantity: 1,
+     *   metadata: {
+     *     engraving_text: 'Happy Birthday!',
+     *     upload_photo: url,
+     *   },
+     * });
+     * ```
      */
     uploadCustomizationFile(file: File | Blob): Promise<{
         url: string;
@@ -6999,4 +7183,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 CartBundleOffer, type CartBundlesResponse, type CartItem, type CartNudge, type CartRecommendationsResponse, type CartStatus, type CartUpgradeSuggestion, type CartUpgradesResponse, type Category, type CategoryNode, 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 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 EmailTemplatesResponse, 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 LockedVariant, 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 OrderBump, 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 ProductCustomizationField, 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 RecommendationVariant, 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 SetCheckoutCustomFieldsDto, 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, getProductCustomizationFields, getProductMetafield, getProductMetafieldValue, getProductMetafieldsByType, getProductPrice, getProductPriceInfo, getProductSwatches, 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 CartBundleOffer, type CartBundlesResponse, type CartIncludeOption, type CartIncludeOptions, type CartItem, type CartNudge, type CartRecommendationsResponse, type CartStatus, type CartUpgradeSuggestion, type CartUpgradesResponse, type CartWithIncludes, type Category, type CategoryNode, 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 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 EmailTemplatesResponse, 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 LockedVariant, 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 OrderBump, type OrderCustomer, type OrderDownloadLink, type OrderItem, type OrderQueryParams, type OrderStatus, type OrderStatusChange, 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 ProductCustomizationField, 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 RecommendationVariant, 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 SetCheckoutCustomFieldsDto, type SetCheckoutCustomerDto, type SetDefinitionProductsDto as SetDefinitionProductsInput, 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, getProductCustomizationFields, getProductMetafield, getProductMetafieldValue, getProductMetafieldsByType, getProductPrice, getProductPriceInfo, getProductSwatches, getStockStatus, getVariantOptions, getVariantPrice, isCouponApplicableToProduct, isHtmlDescription, isWebhookEventType, parseWebhookEvent, verifyWebhook };

package/dist/index.js CHANGED Viewed

@@ -439,11 +439,14 @@ var BrainerceClient = class {
     const controller = new AbortController();
     const timeoutId = setTimeout(() => controller.abort(), this.timeout);
     try {
+      const isFormData = typeof FormData !== "undefined" && body instanceof FormData;
       const headers = {
-        "Content-Type": "application/json",
         "X-SDK-Version": SDK_VERSION,
         "ngrok-skip-browser-warning": "true"
       };
+      if (!isFormData) {
+        headers["Content-Type"] = "application/json";
+      }
       if (this.origin) {
         headers["Origin"] = this.origin;
       }
@@ -462,7 +465,7 @@ var BrainerceClient = class {
       const response = await fetch(url.toString(), {
         method,
         headers,
-        body: body ? JSON.stringify(body) : void 0,
+        body: body ? isFormData ? body : JSON.stringify(body) : void 0,
         signal: controller.signal
       });
       clearTimeout(timeoutId);
@@ -516,11 +519,14 @@ var BrainerceClient = class {
     const controller = new AbortController();
     const timeoutId = setTimeout(() => controller.abort(), this.timeout);
     try {
+      const isFormData = typeof FormData !== "undefined" && body instanceof FormData;
       const headers = {
-        "Content-Type": "application/json",
         "X-SDK-Version": SDK_VERSION,
         "ngrok-skip-browser-warning": "true"
       };
+      if (!isFormData) {
+        headers["Content-Type"] = "application/json";
+      }
       if (this.origin) {
         headers["Origin"] = this.origin;
       }
@@ -536,7 +542,7 @@ var BrainerceClient = class {
       const response = await fetch(url.toString(), {
         method,
         headers,
-        body: body ? JSON.stringify(body) : void 0,
+        body: body ? isFormData ? body : JSON.stringify(body) : void 0,
         signal: controller.signal
       });
       clearTimeout(timeoutId);
@@ -2112,30 +2118,82 @@ var BrainerceClient = class {
   }
   /**
    * Get a cart by ID
+   *
+   * @param cartId - The cart ID
+   * @param options - Optional settings. Use `include` to fetch related data in a single request.
+   *
+   * @example
+   * ```typescript
+   * // Basic cart fetch
+   * const cart = await client.getCart('cart_123');
+   *
+   * // Fetch cart with recommendations, upgrades, and bundles in one call
+   * const enriched = await client.getCart('cart_123', {
+   *   include: ['recommendations', 'upgrades', 'bundles'],
+   * });
+   * console.log(enriched.recommendations); // { recommendations: [...] }
+   * console.log(enriched.upgrades);        // { upgrades: { ... } }
+   * console.log(enriched.bundles);         // { bundles: [...] }
+   * ```
    */
-  async getCart(cartId) {
+  async getCart(cartId, options) {
     if (cartId === this.VIRTUAL_LOCAL_CART_ID) {
       console.warn('getCart("__local__") is deprecated. Use smartGetCart() instead.');
       return this.withGuards(this.localCartToCart(this.getLocalCart()), "cart");
     }
+    const queryParams = options?.include?.length ? { include: options.include.join(",") } : void 0;
     if (this.isVibeCodedMode()) {
-      return this.withGuards(this.vibeCodedRequest("GET", `/cart/${cartId}`), "cart");
+      return this.withGuards(
+        this.vibeCodedRequest("GET", `/cart/${cartId}`, void 0, queryParams),
+        "cart"
+      );
     }
     if (this.storeId && !this.apiKey) {
-      return this.withGuards(this.storefrontRequest("GET", `/cart/${cartId}`), "cart");
+      return this.withGuards(
+        this.storefrontRequest("GET", `/cart/${cartId}`, void 0, queryParams),
+        "cart"
+      );
     }
-    return this.withGuards(this.adminRequest("GET", `/api/v1/cart/${cartId}`), "cart");
+    return this.withGuards(
+      this.adminRequest("GET", `/api/v1/cart/${cartId}`, void 0, queryParams),
+      "cart"
+    );
   }
   /**
-   * Add an item to the cart
+   * Add an item to the cart.
+   *
+   * If the product has `customizationFields` (merchant-defined buyer input
+   * like engraving text, uploaded photos, select options), pass the buyer's
+   * values in `metadata`. Keys must match each field's `key`. For `IMAGE` /
+   * `GALLERY` types, upload the file first via `uploadCustomizationFile()`
+   * and pass the returned URL. The server validates every value against its
+   * `MetafieldDefinition` and rejects the request with HTTP 400 if anything
+   * fails (type mismatch, required missing, not in `enumValues`, etc.).
+   *
+   * Values are snapshotted onto the order line at checkout — later edits to
+   * the field definition do not retroactively change existing orders.
    *
    * @example
    * ```typescript
+   * // Product with no customization fields
    * const cart = await client.addToCart('cart_123', {
    *   productId: 'prod_abc',
    *   quantity: 2,
    *   notes: 'Gift wrap please',
    * });
+   *
+   * // Product WITH customization fields (engraving + photo + select + multi)
+   * const { url: photoUrl } = await client.uploadCustomizationFile(file);
+   * const cart = await client.addToCart('cart_123', {
+   *   productId: 'prod_mug',
+   *   quantity: 1,
+   *   metadata: {
+   *     engraving_text: 'Happy Birthday!',  // TEXT
+   *     frame_color: 'Gold',                // SELECT (must be in enumValues)
+   *     upload_photo: photoUrl,             // IMAGE
+   *     addons: ['Gift wrap'],              // MULTI_SELECT (always array)
+   *   },
+   * });
    * ```
    */
   async addToCart(cartId, item) {
@@ -2783,11 +2841,21 @@ var BrainerceClient = class {
    * Uses promise dedup lock to prevent race conditions on parallel calls.
    * @internal
    */
-  async getOrCreateSessionCart() {
-    if (this._sessionCartPromise) return this._sessionCartPromise;
+  async getOrCreateSessionCart(options) {
+    if (this._sessionCartPromise) {
+      const base = await this._sessionCartPromise;
+      if (options?.include?.length && base.id) {
+        return this.getCart(base.id, options);
+      }
+      return base;
+    }
     this._sessionCartPromise = this._getOrCreateSessionCartImpl();
     try {
-      return await this._sessionCartPromise;
+      const base = await this._sessionCartPromise;
+      if (options?.include?.length && base.id) {
+        return this.getCart(base.id, options);
+      }
+      return base;
     } finally {
       this._sessionCartPromise = null;
     }
@@ -2920,10 +2988,10 @@ var BrainerceClient = class {
    * Caches the cart ID for subsequent calls
    * @internal
    */
-  async getOrCreateCustomerCart() {
+  async getOrCreateCustomerCart(options) {
     if (this.customerCartId) {
       try {
-        const existingCart = await this.getCart(this.customerCartId);
+        const existingCart = await this.getCart(this.customerCartId, options);
         if (existingCart.status === "ACTIVE") {
           return existingCart;
         }
@@ -2936,6 +3004,9 @@ var BrainerceClient = class {
       const cart2 = await this.fetchCustomerCart();
       if (cart2.status === "ACTIVE") {
         this.customerCartId = cart2.id;
+        if (options?.include?.length) {
+          return this.getCart(cart2.id, options);
+        }
         return cart2;
       }
     } catch {
@@ -2987,7 +3058,8 @@ var BrainerceClient = class {
       const updated = await this.addToCart(cart.id, {
         productId: item.productId,
         variantId: item.variantId,
-        quantity: item.quantity
+        quantity: item.quantity,
+        metadata: item.metadata
       });
       return updated;
     } else {
@@ -2995,7 +3067,8 @@ var BrainerceClient = class {
       const updated = await this.addToCart(cart.id, {
         productId: item.productId,
         variantId: item.variantId,
-        quantity: item.quantity
+        quantity: item.quantity,
+        metadata: item.metadata
       });
       this.updateSessionCartItemCount(updated.items?.length ?? 0);
       return updated;
@@ -3008,20 +3081,28 @@ var BrainerceClient = class {
    * - **Guest with session**: Returns server-side session cart
    * - **Guest without session**: Returns empty cart (no server call, cart created lazily on add)
    *
+   * @param options - Optional. Use `include` to fetch recommendations, upgrades, and bundles
+   *   in a single request instead of separate calls.
+   *
    * @example
    * ```typescript
    * const cart = await client.smartGetCart();
    * console.log('Items:', cart.items.length);
+   *
+   * // With includes — single request for cart + extras
+   * const enriched = await client.smartGetCart({
+   *   include: ['recommendations', 'upgrades', 'bundles'],
+   * });
    * ```
    */
-  async smartGetCart() {
+  async smartGetCart(options) {
     if (this.isCustomerLoggedIn()) {
-      return this.getOrCreateCustomerCart();
+      return this.getOrCreateCustomerCart(options);
     } else {
       if (!this.sessionToken) {
         return this.emptyCart();
       }
-      return this.getOrCreateSessionCart();
+      return this.getOrCreateSessionCart(options);
     }
   }
   /**
@@ -5634,6 +5715,32 @@ var BrainerceClient = class {
   async deleteMetafieldDefinition(definitionId) {
     await this.adminRequest("DELETE", `/api/v1/metafield-definitions/${definitionId}`);
   }
+  /**
+   * Replace the list of products a (customer-input) metafield definition is
+   * attached to. Diff-scoped: only rows for this definition are touched, so
+   * concurrent edits to other definitions on the same product are safe.
+   *
+   * Optionally toggles `appliesToAllProducts` in the same call. When that
+   * flag is true the `productIds` list is still respected as the explicit
+   * subset, but buyers will see the field on every product regardless.
+   *
+   * Requires Admin mode (apiKey).
+   *
+   * @example
+   * ```typescript
+   * await client.setDefinitionProducts('def_123', {
+   *   productIds: ['prod_a', 'prod_b'],
+   *   appliesToAllProducts: false,
+   * });
+   * ```
+   */
+  async setDefinitionProducts(definitionId, data) {
+    return this.adminRequest(
+      "PATCH",
+      `/api/v1/metafield-definitions/${definitionId}/products`,
+      data
+    );
+  }
   // -------------------- Metafields: Product Values --------------------
   // These methods require Admin mode (apiKey)
   /**
@@ -5698,9 +5805,35 @@ var BrainerceClient = class {
     );
   }
   /**
-   * Upload a file for product customization (e.g., customer logo for printing).
-   * Available in storefront and vibe-coded modes.
-   * Returns the uploaded file URL and key.
+   * Upload a buyer-submitted file (engraving photo, custom image, etc.) for a
+   * product customization field of type `IMAGE` or `GALLERY`. The returned `url`
+   * is what you pass back in the add-to-cart `metadata` payload.
+   *
+   * Available in storefront and vibe-coded modes — no customer login required.
+   *
+   * Server rules:
+   * - `image/*` MIME only. Other types → HTTP 400.
+   * - Max 5 MB per file.
+   * - Throttled to 10 uploads / minute per IP → HTTP 429.
+   * - Retention: at least 7 days. If the cart never becomes an order, the file
+   *   is reclaimed automatically. Once the order exists, the file is kept for
+   *   order-history purposes.
+   *
+   * @example
+   * ```ts
+   * // On a product page with IMAGE/GALLERY customization fields:
+   * const { url } = await client.uploadCustomizationFile(fileInput.files[0]);
+   *
+   * // Then include the URL in the add-to-cart metadata:
+   * await client.addToCart(cart.id, {
+   *   productId: product.id,
+   *   quantity: 1,
+   *   metadata: {
+   *     engraving_text: 'Happy Birthday!',
+   *     upload_photo: url,
+   *   },
+   * });
+   * ```
    */
   async uploadCustomizationFile(file) {
     const formData = new FormData();