@nok-integration/storefront-react 0.19.53 → 0.20.5

package/dist/index.d.ts

@@ -2558,6 +2558,32 @@ declare function createClient(options: ClientOptions): {
             }[];
         }>;
     };
+    storefrontConfig: {
+        /**
+         * Presentation, analytics and market settings. Unauthenticated: it is read before a
+         * session exists, because the analytics tag has to be in the document that renders
+         * the first product.
+         *
+         * A consumer that cannot reach this must fall back to `STOREFRONT_CONFIG_FALLBACK`
+         * rather than failing — and that value carries no measurement id, so an outage can
+         * only ever serve less analytics.
+         */
+        get: () => Promise<{
+            analytics: {
+                ga4_measurement_id: string | null;
+                debug: boolean;
+            };
+            presentation: {
+                show_cart_tax: boolean;
+                show_size_charts: boolean;
+                show_stock_alerts: boolean;
+            };
+            market: {
+                default_country: string;
+                default_lang: string;
+            };
+        }>;
+    };
     inventory: {
         get: (sku: string) => Promise<{
             sku: string;
@@ -3313,6 +3339,14 @@ export declare interface DaznShopConfig {
     notifications?: 'internal' | 'host';
     onEvent?: OnEvent;
     locale?: string;
+    /**
+     * Controls the shop may draw, when the merchandiser has them switched on.
+     *
+     * Omitted, or omitting a member, means on: a host that says nothing gets the whole
+     * shop. Switching one off removes the control and the flow behind it; it never leaves
+     * a button that does nothing.
+     */
+    features?: ShopFeatures;
 }
 
 /**
@@ -3465,6 +3499,24 @@ export declare interface FilterOption {
  */
 export declare function formatMoney(money: Money, locale?: string): string;
 
+/**
+ * `ShopEvent` as GA4 recommended ecommerce events.
+ *
+ * A pure mapping and nothing else: it loads no tag, reads no globals and sends nothing.
+ * It turns one of our events into the `{ name, params }` a GA4 `gtag('event', …)` call
+ * takes, so a host that already has analytics can adopt our stream without reverse
+ * engineering it, and so the app and DAZN report the same event names for the same fan
+ * actions rather than two vocabularies for one funnel.
+ *
+ * Events with no GA4 equivalent map to `null` rather than to an invented name. A custom
+ * event that looks like a recommended one is worse than no event: it is silently absent
+ * from every standard report while appearing to be present.
+ */
+export declare interface Ga4Event {
+    name: string;
+    params: Record<string, unknown>;
+}
+
 /**
  * Supplies the session bearer token. Called before each authenticated request and again,
  * once, after a `401`.
@@ -5588,6 +5640,7 @@ declare interface ShopContextValue {
     products: ProductCache;
     theme: 'light' | 'dark' | 'auto';
     notifications: 'internal' | 'host';
+    features: Required<ShopFeatures>;
     locale?: string;
     assetBaseUrl?: string;
     emit: OnEvent;
@@ -5709,6 +5762,13 @@ export declare type ShopEvent = {
     scope: string;
 };
 
+declare interface ShopFeatures {
+    /** Offer the size guide on products that have one. */
+    sizeCharts?: boolean;
+    /** Offer "Remind me when available" on an out-of-stock product. */
+    stockAlerts?: boolean;
+}
+
 /**
  * The 64px shop header from Figma `mobile/header` (context=shop): back chevron on the
  * left, cart and overflow on the right.
@@ -6377,6 +6437,8 @@ export declare function ToastProvider({ children }: {
 
 export declare type ToastTone = 'neutral' | 'success' | 'critical';
 
+export declare function toGa4Event(event: ShopEvent): Ga4Event | null;
+
 /** Resolve UI copy + behaviour for an API error code (unknown → generic retriable). */
 export declare function treatmentFor(code: ErrorCode | undefined): ErrorTreatment;