@lime-bundles/react 4.1.0 → 6.0.0

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { CartLineInput, BuyerResolver, ProductVariant, ParsedBundle, WidgetConfig } from '@lime-bundles/core';
-export { ABVariantOverrides, BUNDLES_FOR_PRODUCT_QUERY, BUNDLE_METAOBJECT_QUERY, BundleParseError, BundleType, CartLineInput, CountdownConfig, CtaConfig, DiscountConfig, FixedBundleData, FixedBundlePricing, HeaderConfig, ImageTransform, LayoutConfig, MixMatchBundleData, ParsedBundle, PopularBadgeConfig, PricingConfig, PricingRow, Product, ProductListConfig, ProductVariant, SHOP_CUSTOM_CSS_QUERY, SavingsBarConfig, StorefrontApiError, ThumbnailRatio, VolumeBundleData, VolumeTier, WIDGET_CONFIG_DEFAULTS, WidgetConfig, applyABVariantB, applyWidgetConfigVars, calculateDiscount, calculateTierSavings, computeBundleSaleCents, computeFixedPricing, createStorefrontClient, fetchBundlesForProduct, formatCents, formatCountdown, formatMoney, formatUnitPrice, getABTestAssignment, getActiveTier, hasConsent, injectCustomCss, mergeWidgetConfig, observeImpression, parseCents, parseMetaobjectBundle, parseMetaobjectBundleStrict, percentageDiscountUnit, reportAddToCart, reportImpression, sanitizeCustomCss, setConsent, thumbnailRatioVars, transformImageUrl, validateQuantity } from '@lime-bundles/core';
+import { CartLineInput, BuyerResolver, ProductVariant, ParsedBundle, OutOfStockBehavior, WidgetConfig } from '@lime-bundles/core';
+export { BUNDLES_FOR_PRODUCT_QUERY, BUNDLE_METAOBJECT_QUERY, BogoBundleData, BundleParseError, BundleType, CartLineInput, CountdownConfig, CtaConfig, DEFAULT_OUT_OF_STOCK_BEHAVIOR, DiscountConfig, FixedBundleData, FixedBundlePricing, HeaderConfig, ImageTransform, LayoutConfig, MixMatchBundleData, MultiStepBundleData, OutOfStockBehavior, ParsedBundle, ParsedMultiStep, PopularBadgeConfig, PricingConfig, PricingRow, Product, ProductListConfig, ProductVariant, SHOP_SETTINGS_QUERY, SavingsBarConfig, StorefrontApiError, ThumbnailRatio, VolumeBundleData, VolumeTier, WIDGET_CONFIG_DEFAULTS, WidgetConfig, applyWidgetConfigVars, calculateDiscount, calculateTierSavings, computeBundleSaleCents, computeFixedPricing, createStorefrontClient, fetchBundlesForProduct, formatCents, formatCountdown, formatMoney, formatUnitPrice, getActiveTier, injectCustomCss, mergeWidgetConfig, observeImpression, parseCents, parseMetaobjectBundle, parseMetaobjectBundleStrict, parseOutOfStockBehavior, percentageDiscountUnit, productsForStep, reportAddToCart, reportImpression, sanitizeCustomCss, stepHeadroom, thumbnailRatioVars, transformImageUrl, validateQuantity } from '@lime-bundles/core';
 
 /**
  * Shared props for bundle components.
@@ -59,6 +59,10 @@ declare function MixMatchBundle(props: BundleComponentProps): react_jsx_runtime.
 
 declare function VolumeBundle(props: BundleComponentProps): react_jsx_runtime.JSX.Element | null;
 
+declare function BogoBundle(props: BundleComponentProps): react_jsx_runtime.JSX.Element | null;
+
+declare function MultiStepBundle(props: BundleComponentProps): react_jsx_runtime.JSX.Element | null;
+
 interface VariantDropdownOption {
     value: string;
     label: string;
@@ -158,12 +162,58 @@ interface FetchBundleDataOptions {
 }
 declare function fetchBundleData(options: FetchBundleDataOptions): Promise<ParsedBundle>;
 
-interface FetchShopCustomCssOptions {
+/**
+ * Best-effort fetch for the shop's `$app` settings metafields.
+ *
+ * Returns the raw custom CSS (still needs sanitization before injection — see
+ * `injectCustomCss` from core) and the shop-wide out-of-stock behaviour.
+ *
+ * **Per-shop in-memory cache.** Multiple `<FixedBundle>` / `<VolumeBundle>` /
+ * `<MixMatchBundle>` components on the same page share one network request —
+ * the first caller fetches, concurrent callers await the same promise, and
+ * resolved values are cached so subsequent mounts return instantly. Failures
+ * are NOT cached so the next caller retries.
+ *
+ * The cache lives for the life of the JS module (typically one page load).
+ * Merchants updating settings see changes on the next page load. The cache is
+ * exposed as `__clearShopSettingsCache` for test use only.
+ *
+ * Both metafields ride in one query. The out-of-stock behaviour must be in hand
+ * *before* a bundle renders — a component can't retroactively un-render itself —
+ * so components await this alongside their bundle data rather than after it.
+ */
+
+interface FetchShopSettingsOptions {
     shopDomain: string;
     storefrontAccessToken: string;
     buyerIp?: string;
     signal?: AbortSignal;
 }
+interface ShopSettings {
+    /** Raw, unsanitized merchant CSS. Null when unset. */
+    customCss: string | null;
+    /** Shop-wide handling of products the store can't sell. */
+    outOfStockBehavior: OutOfStockBehavior;
+}
+declare function fetchShopSettings(options: FetchShopSettingsOptions): Promise<ShopSettings>;
+/**
+ * Same fetch, never rejects. Components that need the out-of-stock behaviour
+ * to render at all use this — a failed settings request must not stop a bundle
+ * from appearing.
+ */
+declare function fetchShopSettingsOrDefault(options: FetchShopSettingsOptions): Promise<ShopSettings>;
+
+interface UseShopSettingsOptions {
+    shopDomain: string;
+    storefrontAccessToken: string;
+}
+interface UseShopSettingsResult {
+    outOfStockBehavior: OutOfStockBehavior;
+}
+declare function useShopSettings(options: UseShopSettingsOptions): UseShopSettingsResult;
+
+type FetchShopCustomCssOptions = FetchShopSettingsOptions;
+/** @deprecated Use `fetchShopSettings().customCss`. */
 declare function fetchShopCustomCss(options: FetchShopCustomCssOptions): Promise<string | null>;
 
 interface UseBundleDataOptions {
@@ -222,8 +272,6 @@ interface UseAnalyticsOptions {
     bundleGid: string;
     bundleType: string;
     enabled?: boolean;
-    abTestId?: string;
-    abVariant?: string;
 }
 declare function useAnalytics(options: UseAnalyticsOptions): {
     elementRef: (el: HTMLElement | null) => void;
@@ -237,4 +285,4 @@ declare function useAnalytics(options: UseAnalyticsOptions): {
 
 declare function useWidgetConfigVars(config: WidgetConfig | null | undefined): (el: HTMLElement | null) => void;
 
-export { type BundleComponentProps, type FetchBundleDataOptions, type FetchShopCustomCssOptions, FixedBundle, MixMatchBundle, type UseBundleDataOptions, type UseBundleDataResult, type UseBundlesForProductOptions, type UseBundlesForProductResult, type UseVariantSelectionOptions, type UseVariantSelectionResult, VariantDropdown, type VariantDropdownOption, type VariantDropdownProps, VolumeBundle, fetchBundleData, fetchShopCustomCss, useAnalytics, useBundleData, useBundlesForProduct, useVariantSelection, useWidgetConfigVars };
+export { BogoBundle, type BundleComponentProps, type FetchBundleDataOptions, type FetchShopCustomCssOptions, type FetchShopSettingsOptions, FixedBundle, MixMatchBundle, MultiStepBundle, type ShopSettings, type UseBundleDataOptions, type UseBundleDataResult, type UseBundlesForProductOptions, type UseBundlesForProductResult, type UseShopSettingsOptions, type UseShopSettingsResult, type UseVariantSelectionOptions, type UseVariantSelectionResult, VariantDropdown, type VariantDropdownOption, type VariantDropdownProps, VolumeBundle, fetchBundleData, fetchShopCustomCss, fetchShopSettings, fetchShopSettingsOrDefault, useAnalytics, useBundleData, useBundlesForProduct, useShopSettings, useVariantSelection, useWidgetConfigVars };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { CartLineInput, BuyerResolver, ProductVariant, ParsedBundle, WidgetConfig } from '@lime-bundles/core';
-export { ABVariantOverrides, BUNDLES_FOR_PRODUCT_QUERY, BUNDLE_METAOBJECT_QUERY, BundleParseError, BundleType, CartLineInput, CountdownConfig, CtaConfig, DiscountConfig, FixedBundleData, FixedBundlePricing, HeaderConfig, ImageTransform, LayoutConfig, MixMatchBundleData, ParsedBundle, PopularBadgeConfig, PricingConfig, PricingRow, Product, ProductListConfig, ProductVariant, SHOP_CUSTOM_CSS_QUERY, SavingsBarConfig, StorefrontApiError, ThumbnailRatio, VolumeBundleData, VolumeTier, WIDGET_CONFIG_DEFAULTS, WidgetConfig, applyABVariantB, applyWidgetConfigVars, calculateDiscount, calculateTierSavings, computeBundleSaleCents, computeFixedPricing, createStorefrontClient, fetchBundlesForProduct, formatCents, formatCountdown, formatMoney, formatUnitPrice, getABTestAssignment, getActiveTier, hasConsent, injectCustomCss, mergeWidgetConfig, observeImpression, parseCents, parseMetaobjectBundle, parseMetaobjectBundleStrict, percentageDiscountUnit, reportAddToCart, reportImpression, sanitizeCustomCss, setConsent, thumbnailRatioVars, transformImageUrl, validateQuantity } from '@lime-bundles/core';
+import { CartLineInput, BuyerResolver, ProductVariant, ParsedBundle, OutOfStockBehavior, WidgetConfig } from '@lime-bundles/core';
+export { BUNDLES_FOR_PRODUCT_QUERY, BUNDLE_METAOBJECT_QUERY, BogoBundleData, BundleParseError, BundleType, CartLineInput, CountdownConfig, CtaConfig, DEFAULT_OUT_OF_STOCK_BEHAVIOR, DiscountConfig, FixedBundleData, FixedBundlePricing, HeaderConfig, ImageTransform, LayoutConfig, MixMatchBundleData, MultiStepBundleData, OutOfStockBehavior, ParsedBundle, ParsedMultiStep, PopularBadgeConfig, PricingConfig, PricingRow, Product, ProductListConfig, ProductVariant, SHOP_SETTINGS_QUERY, SavingsBarConfig, StorefrontApiError, ThumbnailRatio, VolumeBundleData, VolumeTier, WIDGET_CONFIG_DEFAULTS, WidgetConfig, applyWidgetConfigVars, calculateDiscount, calculateTierSavings, computeBundleSaleCents, computeFixedPricing, createStorefrontClient, fetchBundlesForProduct, formatCents, formatCountdown, formatMoney, formatUnitPrice, getActiveTier, injectCustomCss, mergeWidgetConfig, observeImpression, parseCents, parseMetaobjectBundle, parseMetaobjectBundleStrict, parseOutOfStockBehavior, percentageDiscountUnit, productsForStep, reportAddToCart, reportImpression, sanitizeCustomCss, stepHeadroom, thumbnailRatioVars, transformImageUrl, validateQuantity } from '@lime-bundles/core';
 
 /**
  * Shared props for bundle components.
@@ -59,6 +59,10 @@ declare function MixMatchBundle(props: BundleComponentProps): react_jsx_runtime.
 
 declare function VolumeBundle(props: BundleComponentProps): react_jsx_runtime.JSX.Element | null;
 
+declare function BogoBundle(props: BundleComponentProps): react_jsx_runtime.JSX.Element | null;
+
+declare function MultiStepBundle(props: BundleComponentProps): react_jsx_runtime.JSX.Element | null;
+
 interface VariantDropdownOption {
     value: string;
     label: string;
@@ -158,12 +162,58 @@ interface FetchBundleDataOptions {
 }
 declare function fetchBundleData(options: FetchBundleDataOptions): Promise<ParsedBundle>;
 
-interface FetchShopCustomCssOptions {
+/**
+ * Best-effort fetch for the shop's `$app` settings metafields.
+ *
+ * Returns the raw custom CSS (still needs sanitization before injection — see
+ * `injectCustomCss` from core) and the shop-wide out-of-stock behaviour.
+ *
+ * **Per-shop in-memory cache.** Multiple `<FixedBundle>` / `<VolumeBundle>` /
+ * `<MixMatchBundle>` components on the same page share one network request —
+ * the first caller fetches, concurrent callers await the same promise, and
+ * resolved values are cached so subsequent mounts return instantly. Failures
+ * are NOT cached so the next caller retries.
+ *
+ * The cache lives for the life of the JS module (typically one page load).
+ * Merchants updating settings see changes on the next page load. The cache is
+ * exposed as `__clearShopSettingsCache` for test use only.
+ *
+ * Both metafields ride in one query. The out-of-stock behaviour must be in hand
+ * *before* a bundle renders — a component can't retroactively un-render itself —
+ * so components await this alongside their bundle data rather than after it.
+ */
+
+interface FetchShopSettingsOptions {
     shopDomain: string;
     storefrontAccessToken: string;
     buyerIp?: string;
     signal?: AbortSignal;
 }
+interface ShopSettings {
+    /** Raw, unsanitized merchant CSS. Null when unset. */
+    customCss: string | null;
+    /** Shop-wide handling of products the store can't sell. */
+    outOfStockBehavior: OutOfStockBehavior;
+}
+declare function fetchShopSettings(options: FetchShopSettingsOptions): Promise<ShopSettings>;
+/**
+ * Same fetch, never rejects. Components that need the out-of-stock behaviour
+ * to render at all use this — a failed settings request must not stop a bundle
+ * from appearing.
+ */
+declare function fetchShopSettingsOrDefault(options: FetchShopSettingsOptions): Promise<ShopSettings>;
+
+interface UseShopSettingsOptions {
+    shopDomain: string;
+    storefrontAccessToken: string;
+}
+interface UseShopSettingsResult {
+    outOfStockBehavior: OutOfStockBehavior;
+}
+declare function useShopSettings(options: UseShopSettingsOptions): UseShopSettingsResult;
+
+type FetchShopCustomCssOptions = FetchShopSettingsOptions;
+/** @deprecated Use `fetchShopSettings().customCss`. */
 declare function fetchShopCustomCss(options: FetchShopCustomCssOptions): Promise<string | null>;
 
 interface UseBundleDataOptions {
@@ -222,8 +272,6 @@ interface UseAnalyticsOptions {
     bundleGid: string;
     bundleType: string;
     enabled?: boolean;
-    abTestId?: string;
-    abVariant?: string;
 }
 declare function useAnalytics(options: UseAnalyticsOptions): {
     elementRef: (el: HTMLElement | null) => void;
@@ -237,4 +285,4 @@ declare function useAnalytics(options: UseAnalyticsOptions): {
 
 declare function useWidgetConfigVars(config: WidgetConfig | null | undefined): (el: HTMLElement | null) => void;
 
-export { type BundleComponentProps, type FetchBundleDataOptions, type FetchShopCustomCssOptions, FixedBundle, MixMatchBundle, type UseBundleDataOptions, type UseBundleDataResult, type UseBundlesForProductOptions, type UseBundlesForProductResult, type UseVariantSelectionOptions, type UseVariantSelectionResult, VariantDropdown, type VariantDropdownOption, type VariantDropdownProps, VolumeBundle, fetchBundleData, fetchShopCustomCss, useAnalytics, useBundleData, useBundlesForProduct, useVariantSelection, useWidgetConfigVars };
+export { BogoBundle, type BundleComponentProps, type FetchBundleDataOptions, type FetchShopCustomCssOptions, type FetchShopSettingsOptions, FixedBundle, MixMatchBundle, MultiStepBundle, type ShopSettings, type UseBundleDataOptions, type UseBundleDataResult, type UseBundlesForProductOptions, type UseBundlesForProductResult, type UseShopSettingsOptions, type UseShopSettingsResult, type UseVariantSelectionOptions, type UseVariantSelectionResult, VariantDropdown, type VariantDropdownOption, type VariantDropdownProps, VolumeBundle, fetchBundleData, fetchShopCustomCss, fetchShopSettings, fetchShopSettingsOrDefault, useAnalytics, useBundleData, useBundlesForProduct, useShopSettings, useVariantSelection, useWidgetConfigVars };