@shopify/hydrogen 2026.4.5 → 2026.4.7

package/dist/oxygen/index.d.ts

@@ -90,6 +90,31 @@ type VisitorConsent = {
     preferences: ConsentStatus;
     sale_of_data: ConsentStatus;
 };
+/** Consent choices returned by the Customer Privacy API. */
+type VisitorConsentValues = Record<keyof VisitorConsent, 'yes' | 'no' | ''>;
+type CustomerPrivacyConfiguration = {
+    isHeadless?: boolean;
+    asyncConsent?: boolean;
+    asyncVisitorState?: boolean;
+    consentDomain?: string;
+    storefrontAccessToken?: string;
+    injectedConsent?: string;
+    debug?: {
+        hydrogen?: {
+            generation: number;
+            serverTiming: boolean;
+        };
+        [key: string]: unknown;
+    };
+};
+type VisitorConsentCollected = {
+    analyticsAllowed: boolean;
+    firstPartyMarketingAllowed: boolean;
+    marketingAllowed: boolean;
+    preferencesAllowed: boolean;
+    saleOfDataAllowed: boolean;
+    thirdPartyMarketingAllowed: boolean;
+};
 type CustomerPrivacyConsentConfig = {
     checkoutRootDomain: string;
     storefrontRootDomain?: string;
@@ -98,11 +123,11 @@ type CustomerPrivacyConsentConfig = {
     /** The privacyBanner refers to `language` as `locale`  */
     locale?: LanguageCode;
 };
-type SetConsentHeadlessParams = VisitorConsent & CustomerPrivacyConsentConfig & {
+type SetConsentHeadlessParams = Partial<VisitorConsent> & CustomerPrivacyConsentConfig & {
     headlessStorefront?: boolean;
 };
 /**
-  Ideally this type should come from the Custoemr Privacy API sdk
+  Ideally this type should come from the Customer Privacy API sdk
   analyticsProcessingAllowed -
   currentVisitorConsent
   doesMerchantSupportGranularConsent
@@ -119,7 +144,9 @@ type SetConsentHeadlessParams = VisitorConsent & CustomerPrivacyConsentConfig &
   thirdPartyMarketingAllowed
 **/
 type OriginalCustomerPrivacy = {
-    currentVisitorConsent: () => VisitorConsent;
+    currentVisitorConsent: () => VisitorConsentValues;
+    consentStatus?: 'loading' | 'loaded';
+    config?: CustomerPrivacyConfiguration;
     preferencesProcessingAllowed: () => boolean;
     saleOfDataAllowed: () => boolean;
     marketingAllowed: () => boolean;
@@ -130,7 +157,7 @@ type OriginalCustomerPrivacy = {
     shouldShowBanner: () => boolean;
 };
 type CustomerPrivacy = Omit<OriginalCustomerPrivacy, 'setTrackingConsent'> & {
-    setTrackingConsent: (consent: VisitorConsent, // we have already applied the headlessStorefront in the override
+    setTrackingConsent: (consent: Partial<VisitorConsent>, // we have already applied the headlessStorefront in the override
     callback: (data: {
         error: string;
     } | undefined) => void) => void;
@@ -139,6 +166,11 @@ type PrivacyBanner = {
     loadBanner: (options?: Partial<CustomerPrivacyConsentConfig>) => void;
     showPreferences: (options?: Partial<CustomerPrivacyConsentConfig>) => void;
 };
+interface CustomEventMap {
+    visitorConsentCollected: CustomEvent<VisitorConsentCollected>;
+    consentTrackingApiLoaded: Event;
+    shopifyCustomerPrivacyApiLoaded: CustomEvent<null>;
+}
 
 type WaitUntil = (promise: Promise<unknown>) => void;
 
@@ -159,9 +191,9 @@ declare global {
   interface Window {
     privacyBanner: PrivacyBanner;
     Shopify: {
-      customerPrivacy?: Partial<CustomerPrivacy> & {
-        backendConsentEnabled?: boolean;
-      };
+      country?: string;
+      locale?: string;
+      customerPrivacy?: Partial<CustomerPrivacy>;
     };
   }
   interface Document {