@lime-bundles/react 3.0.0 → 4.1.0

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { CartLineInput, ProductVariant, ParsedBundle, WidgetConfig } from '@lime-bundles/core';
+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';
 
 /**
@@ -32,6 +32,25 @@ interface BundleComponentProps {
     analyticsEnabled?: boolean;
     /** Called with the thrown `Error` from fetchBundleData or onAddToCart. */
     onError?: (error: Error) => void;
+    /**
+     * ISO-3166 alpha-2 country code, passed as Storefront `@inContext(country:)`.
+     * Drives Markets pricing and currency. Omit for shop default.
+     */
+    country?: string;
+    /** ISO-639-1 language code, passed as `@inContext(language:)`. */
+    language?: string;
+    /**
+     * B2B buyer identity. Prefer the callback form (`() => Promise<BuyerInput>`)
+     * so the customer access token doesn't live in static prop trees. See
+     * the package README ("Markets & B2B") for the security threat model.
+     */
+    buyer?: BuyerResolver;
+    /**
+     * Current visitor's Shopify Market GID. When set and the bundle's
+     * `marketVisibility === "specific"`, the bundle is hidden if its
+     * `marketIds` doesn't include this market.
+     */
+    marketId?: string;
 }
 
 declare function FixedBundle(props: BundleComponentProps): react_jsx_runtime.JSX.Element | null;
@@ -116,6 +135,26 @@ interface FetchBundleDataOptions {
     signal?: AbortSignal;
     /** Override the Storefront API version pinned in `createStorefrontClient`. */
     apiVersion?: string;
+    /**
+     * ISO-3166 alpha-2 country code passed as `@inContext(country: ...)`.
+     * Drives Shopify Markets pricing, currency, and availability.
+     */
+    country?: string;
+    /** ISO-639-1 language code passed as `@inContext(language: ...)`. */
+    language?: string;
+    /**
+     * B2B buyer identity. Prefer the callback form for security — it lets
+     * you fetch the customer access token just-in-time so it doesn't sit
+     * in static prop trees. See packages/*\/README.md → "Markets & B2B".
+     */
+    buyer?: BuyerResolver;
+    /**
+     * Shopify Market GID for the current visitor. When set and the bundle's
+     * `marketVisibility === "specific"`, the bundle is filtered out if its
+     * `marketIds` doesn't include this market. Returned to the caller via
+     * `BundleVisibilityWarning[]` for surfacing.
+     */
+    marketId?: string;
 }
 declare function fetchBundleData(options: FetchBundleDataOptions): Promise<ParsedBundle>;
 
@@ -131,6 +170,14 @@ interface UseBundleDataOptions {
     shopDomain: string;
     storefrontAccessToken: string;
     bundleGid: string;
+    /** ISO-3166 alpha-2 country, passed as Storefront `@inContext(country:)`. */
+    country?: string;
+    /** ISO-639-1 language, passed as `@inContext(language:)`. */
+    language?: string;
+    /** B2B buyer identity. Prefer the callback form to keep tokens off prop trees. */
+    buyer?: BuyerResolver;
+    /** Current visitor's Market GID — filters market-restricted bundles client-side. */
+    marketId?: string;
 }
 type UseBundleDataResult = {
     status: "loading";

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { CartLineInput, ProductVariant, ParsedBundle, WidgetConfig } from '@lime-bundles/core';
+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';
 
 /**
@@ -32,6 +32,25 @@ interface BundleComponentProps {
     analyticsEnabled?: boolean;
     /** Called with the thrown `Error` from fetchBundleData or onAddToCart. */
     onError?: (error: Error) => void;
+    /**
+     * ISO-3166 alpha-2 country code, passed as Storefront `@inContext(country:)`.
+     * Drives Markets pricing and currency. Omit for shop default.
+     */
+    country?: string;
+    /** ISO-639-1 language code, passed as `@inContext(language:)`. */
+    language?: string;
+    /**
+     * B2B buyer identity. Prefer the callback form (`() => Promise<BuyerInput>`)
+     * so the customer access token doesn't live in static prop trees. See
+     * the package README ("Markets & B2B") for the security threat model.
+     */
+    buyer?: BuyerResolver;
+    /**
+     * Current visitor's Shopify Market GID. When set and the bundle's
+     * `marketVisibility === "specific"`, the bundle is hidden if its
+     * `marketIds` doesn't include this market.
+     */
+    marketId?: string;
 }
 
 declare function FixedBundle(props: BundleComponentProps): react_jsx_runtime.JSX.Element | null;
@@ -116,6 +135,26 @@ interface FetchBundleDataOptions {
     signal?: AbortSignal;
     /** Override the Storefront API version pinned in `createStorefrontClient`. */
     apiVersion?: string;
+    /**
+     * ISO-3166 alpha-2 country code passed as `@inContext(country: ...)`.
+     * Drives Shopify Markets pricing, currency, and availability.
+     */
+    country?: string;
+    /** ISO-639-1 language code passed as `@inContext(language: ...)`. */
+    language?: string;
+    /**
+     * B2B buyer identity. Prefer the callback form for security — it lets
+     * you fetch the customer access token just-in-time so it doesn't sit
+     * in static prop trees. See packages/*\/README.md → "Markets & B2B".
+     */
+    buyer?: BuyerResolver;
+    /**
+     * Shopify Market GID for the current visitor. When set and the bundle's
+     * `marketVisibility === "specific"`, the bundle is filtered out if its
+     * `marketIds` doesn't include this market. Returned to the caller via
+     * `BundleVisibilityWarning[]` for surfacing.
+     */
+    marketId?: string;
 }
 declare function fetchBundleData(options: FetchBundleDataOptions): Promise<ParsedBundle>;
 
@@ -131,6 +170,14 @@ interface UseBundleDataOptions {
     shopDomain: string;
     storefrontAccessToken: string;
     bundleGid: string;
+    /** ISO-3166 alpha-2 country, passed as Storefront `@inContext(country:)`. */
+    country?: string;
+    /** ISO-639-1 language, passed as `@inContext(language:)`. */
+    language?: string;
+    /** B2B buyer identity. Prefer the callback form to keep tokens off prop trees. */
+    buyer?: BuyerResolver;
+    /** Current visitor's Market GID — filters market-restricted bundles client-side. */
+    marketId?: string;
 }
 type UseBundleDataResult = {
     status: "loading";

package/dist/index.js

@@ -11,24 +11,43 @@ import {
 
 // src/hooks/useBundleData.ts
 import { useState, useEffect } from "react";
-import { injectCustomCss } from "@lime-bundles/core";
+import {
+  injectCustomCss
+} from "@lime-bundles/core";
 
 // src/fetchBundleData.ts
 import {
   createStorefrontClient,
+  hasInContext,
   BUNDLE_METAOBJECT_QUERY,
+  withInContext,
   parseMetaobjectBundleStrict,
   BundleParseError
 } from "@lime-bundles/core";
 async function fetchBundleData(options) {
-  const client = createStorefrontClient({
+  const result = await fetchBundleDataWithWarnings(options);
+  if (!result.bundle) {
+    throw new BundleParseError(
+      `Bundle hidden by market gate: ${options.bundleGid}`,
+      "not_found"
+    );
+  }
+  return result.bundle;
+}
+async function fetchBundleDataWithWarnings(options) {
+  const config = {
     shopDomain: options.shopDomain,
     accessToken: options.storefrontAccessToken,
     buyerIp: options.buyerIp,
-    apiVersion: options.apiVersion
-  });
+    apiVersion: options.apiVersion,
+    country: options.country,
+    language: options.language,
+    buyer: options.buyer
+  };
+  const client = createStorefrontClient(config);
+  const query = hasInContext(config) ? withInContext(BUNDLE_METAOBJECT_QUERY) : BUNDLE_METAOBJECT_QUERY;
   const data = await client.query(
-    BUNDLE_METAOBJECT_QUERY,
+    query,
     { id: options.bundleGid },
     { signal: options.signal }
   );
@@ -38,10 +57,24 @@ async function fetchBundleData(options) {
       "not_found"
     );
   }
-  return parseMetaobjectBundleStrict(
+  const bundle = parseMetaobjectBundleStrict(
     data.metaobject.id,
     data.metaobject.fields
   );
+  if (bundle.marketVisibility === "specific" && (!options.marketId || !bundle.marketIds.includes(options.marketId))) {
+    return {
+      bundle: null,
+      warnings: [
+        {
+          bundleGid: options.bundleGid,
+          reason: "market_mismatch",
+          currentMarketId: options.marketId ?? null,
+          allowedMarketIds: bundle.marketIds
+        }
+      ]
+    };
+  }
+  return { bundle, warnings: [] };
 }
 
 // src/fetchShopCustomCss.ts
@@ -90,7 +123,11 @@ function useBundleData(options) {
       shopDomain: options.shopDomain,
       storefrontAccessToken: options.storefrontAccessToken,
       bundleGid: options.bundleGid,
-      signal: controller.signal
+      signal: controller.signal,
+      country: options.country,
+      language: options.language,
+      buyer: options.buyer,
+      marketId: options.marketId
     }).then((bundle) => {
       if (controller.signal.aborted) return;
       setState({ status: "success", bundle, error: null });
@@ -117,7 +154,11 @@ function useBundleData(options) {
   }, [
     options.shopDomain,
     options.storefrontAccessToken,
-    options.bundleGid
+    options.bundleGid,
+    options.country,
+    options.language,
+    options.buyer,
+    options.marketId
   ]);
   return state;
 }